a. How Do I?b. What's New?c. Top 10 Taskse. Search IndexRef a. Setting UpRef b. WorkspaceRef c. ShortcutsRef d. ScriptingRef e. @FunctionsRef f. Troubleshooting.
Use DatabasesUse ViewsUse DocumentsSearch for InformationUse MailPrint Documents and ViewsKeep Notes SecureShare Information With Other ApplicationsUse Notes Away from a NetworkDesign Notes DatabasesManage Notes DatabasesAdminister Notes Servers---Where is this Release 3 command?What are the important new features?What changed at the last minute?How do I upgrade my site to Release 4?----Things you do before startingThings you do every dayThings you do frequentlyOther things-----About NotesSetting Up NotesStarting & Stopping NotesAbout Other Notes Documentation------About MenusAbout the SmartIcons PaletteAbout WindowsAbout FoldersAbout Split PanesAbout the Status Bar-------SmartIcon ShortcutsMouse ShortcutsKeyboard Shortcuts--------About ScriptingLotusScript BasicsLotusScript Reference----------@Functions Basics@Functions Reference@Commands Basics@Comands Reference---------About MessagesAbout Customer SupportList of Messagest
lotus.notes.International classInternational settingsRegional settingsInternational propertyProgStepsAllH_ACCESSING_INTERNATIONAL_SETTINGS_JAVAContext Help FormAccessing international settings
Compiling a Java programRunning a Java programCLASSPATHset CLASSPATHlotus.notes packageThreadsRunnable interfaceNotesThread classAgentBase classSession classSystem.outSystem.errgetSession methodAgentsAllH_COMPILING_AND_RUNNING_JAVAContext Help FormCompiling and running a Java program
The three most important things you need to know about help are:
To find an entry in the Index view, click the view pane, type as many letters as you want of the entry you're looking for, and click OK. Click the green triangle next to any index entry to expand its documents.
To jump from one topic to another, double-click green
underlined
text (press green text in a box for a pop-up definition of a term). To return to where you were, click Go Back. You can also return to the Contents screen by clicking Help Topics at the top of any topic.
To search for a word or phrase anywhere in the help, click Search in the navigation pane and follow the instructions in the box in the navigation pane. When you search, Notes shows all the topics that contain the word or phrase, in order of the most occurrences.
About editing and printing help topics
To suit the needs of your site, you can create a replica of this database and edit its documents strictly for the sole use of users within your organization. You cannot resell or otherwise distribute this documentation, modified or unmodified, to anyone outside your organization. Lotus assumes no responsibility for the technical accuracy of any modifications made to this documentation or the operation of Lotus products in reliance on such modifications.
O=Lotus Notes
O=Lotus Notes
PURSAFO
|.:#U
O=Lotus Notes
CN=Lotus Notes Template Development/O=Lotus Notes
PURSAFO
Fde!f^^
<]<XJ
$INFO
$BODY
ACTIVE
ACTIVE
PERUSEACTIVE
SEARCH BAR
ACTIVE
ACTIVE
ACTIVE
ACTIVE
23100
63199
23198
23178
23095
13354
13321
13324
15284
13429
ACTIVE
ACTIVE
|0m1:
AGENTDESIGN ACTIVE
Database 'Notes Help Template 1.05 1_3_95', View 'b. Index|
DATABASE ACTIVE PERUSE
Database 'Notes Help Template 1.05 1_3_95', View 'b. Index|
DATABASE ACTIVE SEARCH BAR
Database 'Notes Help Template 1.05 1_3_95', View 'b. Index|
DESK ACTIVE
Database 'Notes Help Template 1.05 1_3_95', View 'b. Index|
DIALOG 1778
Database 'Notes Help Template 1.05 1_3_95', View 'b. Index|
DIALOG 2667
Database 'Notes Help Template 1.05 1_3_95', View 'b. Index|'
DIALOG 2693
Database 'Notes Help Template 1.05 1_3_95', View 'b. Index|
DIALOG 2695
Database 'Notes Help Template 1.05 1_3_95', View 'b. Index|
DIALOG 2709
Database 'Notes Help Template 1.05 1_3_95', View 'b. Index|
DIALOG 2721
Database 'Notes Help Template 1.05 1_3_95', View 'b. Index|
DIALOG 2747
Database 'Notes Help Template 1.05 1_3_95', View 'b. Index|
DIALOG 2780
Database 'Notes Help Template 1.05 1_3_95', View 'b. Index|
DIALOG 2787
Database 'Notes Help Template 1.05 1_3_95', View 'b. Index|
DIALOG 2791
Database 'Notes Help Template 1.05 1_3_95', View 'b. Index|E
DIALOG 2794
Database 'Notes Help Template 1.05 1_3_95', View 'b. Index|
DIALOG 2795
Database 'Notes Help Template 1.05 1_3_95', View 'b. Index|
DIALOG 2798
Database 'Notes Help Template 1.05 1_3_95', View 'b. Index|
DIALOG 2799
Database 'Notes Help Template 1.05 1_3_95', View 'b. Index|
DIALOG 2810
Database 'Notes Help Template 1.05 1_3_95', View 'b. Index|
DIALOG 2814
Database 'Notes Help Template 1.05 1_3_95', View 'b. Index|i
DIALOG 3028
Database 'Notes Help Template 1.05 1_3_95', View 'b. Index|&
DIALOG 7165
Database 'Notes Help Template 1.05 1_3_95', View 'b. Index|
DIALOG 9495
Database 'Notes Help Template 1.05 1_3_95', View 'b. Index|
DIALOG 9499
Database 'Notes Help Template 1.05 1_3_95', View 'b. Index|
DIALOG 9959
Database 'Notes Help Template 1.05 1_3_95', View 'b. Index|C
DOCUMENT ACTIVE
Database 'Notes Help Template 1.05 1_3_95', View 'b. Index|:
FORMDESIGN ACTIVE
Database 'Notes Help Template 1.05 1_3_95', View 'b. Index|
FORMDESIGN ACTIVE
Database 'Notes Help Template 1.05 1_3_95', View 'b. Index|
MESSAGE 1029
Database 'Notes Help Template 1.05 1_3_95', View 'b. Index|e
MESSAGE 1045
Database 'Notes Help Template 1.05 1_3_95', View 'b. Index|
MESSAGE 1068 2
Database 'Notes Help Template 1.05 1_3_95', View 'b. Index|
MESSAGE 1072
Database 'Notes Help Template 1.05 1_3_95', View 'b. Index|
MESSAGE 1290 H
Database 'Notes Help Template 1.05 1_3_95', View 'b. Index|
MESSAGE 1291 3
Database 'Notes Help Template 1.05 1_3_95', View 'b. Index|e
MESSAGE 1294 2 t
Database 'Notes Help Template 1.05 1_3_95', View 'b. Index|
MESSAGE 1303
Database 'Notes Help Template 1.05 1_3_95', View 'b. Index|.
MESSAGE 1310 2
Database 'Notes Help Template 1.05 1_3_95', View 'b. Index|
MESSAGE 13321 6
Database 'Notes Help Template 1.05 1_3_95', View 'b. Index|
MESSAGE 13324 6
Database 'Notes Help Template 1.05 1_3_95', View 'b. Index|$
MESSAGE 13354 2
Database 'Notes Help Template 1.05 1_3_95', View 'b. Index|
MESSAGE 13429 2
Database 'Notes Help Template 1.05 1_3_95', View 'b. Index|
MESSAGE 1347
Database 'Notes Help Template 1.05 1_3_95', View 'b. Index|
MESSAGE 15284 2
Database 'Notes Help Template 1.05 1_3_95', View 'b. Index|u
MESSAGE 258
Database 'Notes Help Template 1.05 1_3_95', View 'b. Index|o
MESSAGE 259 2
Database 'Notes Help Template 1.05 1_3_95', View 'b. Index|l
MESSAGE 269
Database 'Notes Help Template 1.05 1_3_95', View 'b. Index|F
MESSAGE 2834 2
Database 'Notes Help Template 1.05 1_3_95', View 'b. Index|
MESSAGE 302 2
Database 'Notes Help Template 1.05 1_3_95', View 'b. Index|o
MESSAGE 3089 2 I
Database 'Notes Help Template 1.05 1_3_95', View 'b. Index|h
MESSAGE 3095 2 s
Database 'Notes Help Template 1.05 1_3_95', View 'b. Index|
MESSAGE 3100 6
Database 'Notes Help Template 1.05 1_3_95', View 'b. Index|V
MESSAGE 3119
Database 'Notes Help Template 1.05 1_3_95', View 'b. Index|
MESSAGE 3163
Database 'Notes Help Template 1.05 1_3_95', View 'b. Index|v
MESSAGE 3178 2
Database 'Notes Help Template 1.05 1_3_95', View 'b. Index|
MESSAGE 3197
Database 'Notes Help Template 1.05 1_3_95', View 'b. Index|
MESSAGE 3198 N
Database 'Notes Help Template 1.05 1_3_95', View 'b. Index|
MESSAGE 3199
Database 'Notes Help Template 1.05 1_3_95', View 'b. Index|^
MESSAGE 3211
Database 'Notes Help Template 1.05 1_3_95', View 'b. Index|
MESSAGE 3215
Database 'Notes Help Template 1.05 1_3_95', View 'b. Index|
MESSAGE 3233
Database 'Notes Help Template 1.05 1_3_95', View 'b. Index|
MESSAGE 3303 1
Database 'Notes Help Template 1.05 1_3_95', View 'b. Index|
MESSAGE 3306
Database 'Notes Help Template 1.05 1_3_95', View 'b. Index|
MESSAGE 3343
Database 'Notes Help Template 1.05 1_3_95', View 'b. Index|
MESSAGE 3364 2
Database 'Notes Help Template 1.05 1_3_95', View 'b. Index|
MESSAGE 3373 8
Database 'Notes Help Template 1.05 1_3_95', View 'b. Index|
MESSAGE 3446
Database 'Notes Help Template 1.05 1_3_95', View 'b. Index|
MESSAGE 3533
Database 'Notes Help Template 1.05 1_3_95', View 'b. Index|%
MESSAGE 3595
Database 'Notes Help Template 1.05 1_3_95', View 'b. Index|P
MESSAGE 3857 1
Database 'Notes Help Template 1.05 1_3_95', View 'b. Index|
MESSAGE 549 2
Database 'Notes Help Template 1.05 1_3_95', View 'b. Index|
MESSAGE 553
Database 'Notes Help Template 1.05 1_3_95', View 'b. Index|&
MESSAGE 591 2
Database 'Notes Help Template 1.05 1_3_95', View 'b. Index|~
MESSAGE 5929
Database 'Notes Help Template 1.05 1_3_95', View 'b. Index|
MESSAGE 609 2
Database 'Notes Help Template 1.05 1_3_95', View 'b. Index|
MESSAGE 6402
Database 'Notes Help Template 1.05 1_3_95', View 'b. Index|
MESSAGE 641
Database 'Notes Help Template 1.05 1_3_95', View 'b. Index|
MESSAGE 645
Database 'Notes Help Template 1.05 1_3_95', View 'b. Index|
MESSAGE 972 1540
Database 'Notes Help Template 1.05 1_3_95', View 'b. Index|
NAVIGATOR ACTIVE
Database 'Notes Help Template 1.05 1_3_95', View 'b. Index|
VIEWDESIGN ACTIVE
Database 'Notes Help Template 1.05 1_3_95', View 'b. Index|
"Helvetica
Indented List
Bullet
Indented Text
Numbered List
BHead
CHead
IndPara
Bullet
BHead
CHead
Body Text
About help
This is a Notes database.
Choose Help - Using This Database for information on using help.
Copyright
Under the copyright laws, neither the documentation nor the software may be copied, photocopied, reproduced, translated, or reduced to any electronic medium or machine-readable form, in whole or in part, without the prior written consent of Lotus Development Corporation, except in the manner described in the documentation.
Copyright 1997
Lotus Development Corporation
55 Cambridge Parkway
Cambridge, MA 02142
All Rights Reserved.
Printed in the United States.
Revision History:
Original: Original material produced for Lotus Domino and Lotus Notes.
List of trademarks
List of trademarks
Annotator, Lotus Notes Express, Lotus Organizer, Notes/FX, PowerKey, ScreenCam, Seamless Object, SmartMaster, and Working Together are trademarks and Lotus, Lotus Express, Improv, Lotus Notes, Agenda, Ami Pro, Approach, DataLens, Freelance, Freelance Graphics, Graphwriter, Manuscript, 1-2-3, 1-2-3/G, SmartIcons, SmartSuite, and Symphony are registered trademarks of Lotus Development Corporation. PostScript is a registered trademark of Adobe Systems, Inc. Helvetica and Times are registered trademarks of Allied Corporation, licensed to Apple Computer, Inc. Balloon Help, Finder, System 7, and PowerBook are trademarks and Apple, Apple File Exchange, AppleTalk, Macintosh, MacPaint, MacTCP, and MacWrite are registered trademarks of Apple Computer, Inc. Claris and MacDraw are registered trademarks of Apple Computer, Inc., licensed to Claris Corporation. MultiMate is a registered trademark of Ashton-Tate Corporation. Borland and Paradox are registered trademarks of Borland International, Inc. cc:Mail is a trademark of cc:Mail, Inc., a wholly owned subsidiary of Lotus Development Corporation. COMPAQ is a registered trademark of COMPAQ Computer Corporation. DOS Mounter is a trademark and Dayna is a registered trademark of Dayna Communications, Inc. DEC and VAX Mail are trademarks and VAX is a registered trademark of Digital Equipment Corporation. IBM, DisplayWrite, OS/2, and Presentation Manager are registered trademarks of International Business Machines Corporation. Frame Maker is a registered trademark of Frame Technologies, Inc. Access PC and Insignia are trademarks of Insignia Solutions, Inc. 3-for-3 is a registered trademark of Iris Associates, Inc. MasterSoft is a registered trademark of MasterSoft, Inc. Metafile is a registered trademark of Donald H. McNeil. MicroPro and WordStar are registered trademarks of MicroPro International Corporation. Windows is a trademark and Microsoft and MS-DOS are registered trademarks of Microsoft Corporation. Q+E is a registered trademark of Pioneer Software Systems, Inc. Remark! is a registered trademark of Simpact Associates, Inc. Soft
Switch is a registered trademark of Soft
Switch, Inc. UNIX is a registered trademark of X/Open Company Limited. WordPerfect is a registered trademark of WordPerfect Corporation. WordStar is a registered trademark of WordStar International, Inc. Paintbrush and PC Paintbrush are registered trademarks of Zsoft Corporation.
Vendor Independent Messaging (VIM) Specification, Copyright 1992 Apple Computer, Inc., Borland International, Inc., International Business Machines Corporation, Lotus Development Corporation, MCI International, Inc., Novell, Inc., Oracle Corporation and WordPerfect Corporation. All rights reserved.
International CorrectspellTM English licensed from Houghton Mifflin Company.
Copyright
1991 by Houghton Mifflin Company. All rights reserved.
Reproduction or disassembly of embodied algorithms or database prohibited.
Context Help Form'++LotusScript Development Environment:2:5:(Options):0:66
'++LotusScript Development Environment:2:5:(Forward):0:1
Declare Sub Queryopen(Source As Notesuidocument, Mode As Integer, Isnewdoc As Variant, Continue As Variant)
Declare Sub Querymodechange(Source As Notesuidocument, Continue As Variant)
'++LotusScript Development Environment:2:5:(Declarations):0:2
'++LotusScript Development Environment:2:2:BindEvents:1:129
Private Sub BindEvents(Byval Objectname_ As String)
Static Source As NOTESUIDOCUMENT
Set Source = Bind(Objectname_)
On Event Queryopen From Source Call Queryopen
On Event Querymodechange From Source Call Querymodechange
End Sub
'++LotusScript Development Environment:2:2:Queryopen:1:12
Sub Queryopen(Source As Notesuidocument, Mode As Integer, Isnewdoc As Variant, Continue As Variant)
If ( source.EditMode ) Then
Messagebox("If your organization needs to customize Help topics, see your Notes administrator for assistance.")
continue = False
End If
End Sub
'++LotusScript Development Environment:2:2:Querymodechange:1:12
Sub Querymodechange(Source As Notesuidocument, Continue As Variant)
If Not ( source.EditMode ) Then
continue = False
End If
End Sub
SubjectAssign a topic name to this document.
BodyWrite the body of the help document here.
TopicType
GuideMe
1S2S
To respond to Lotus with your comments, you must have a connection to the World Wide Web and a browser specified in your Location document. Check with your server administrator for information on your Internet connection, and look in Notes Help for information on how to configure your Notes workstation to connect to the Web.
If you're connected to the Web
String corrected to new 4.6 version, including release number, on 4/14/97
To print all the topics in this database, make sure your printer is ready, and click Yes.
resetpages
0R9S
Print Selected Topics
Are you ready to print?
To print all the topics you have selected, make sure your printer is ready, and click Yes.
resetpages
Expand All
0S0E
Collapse All
0S0E
Domino
ViewNextPage
Web Button
This button works only if you're browsing this information over the Web.
0R6S
$$WebClient
0S0E
Previous
Domino
ViewPreviousPage
Web Button
This button works only if you're browsing this information over the Web.
0R6S
$$WebClient
0S0E
Search
0S0E
Web Button
Use this button only if you're browsing this information over the Web.
0R6S
$$WebClient
0S0E
Categori_ze
_Edit Document
Send Docu_ment
_Forward
_Move To Folder...
_Remove From Folder
O=Lotus Notes
O=Lotus Notes
PURSAFO
|.:#U
O=Lotus Notes
CN=Lotus Notes Template Development/O=Lotus Notes
PURSAFO
Fde!f^^
N3$]!
$Author
$TITLE
$Index
$Formula
$FormulaClass
$ViewFormat
$Comment
$ACTIONS
a. Contents
TextBox1Contents
TextBox2Index1
TextBox2Search
Rectangle2
Text3Favorite Topics
GraphicButton18
Text5Translators:
1. Translate and size as needed the text blocks in this navigator.
2. Choose View - Show and show this navigator.
3. Snap a picture of the navigator, starting exactly from the top left corner. Save the picture in the clipboard.
4. Open the equivalent real navigator, choose Design - Remove Graphic Background, and then choose Create - Graphic Background to use the picture you snapped.
5. Adjust the size of the hotspots as needed for the new language.
6. Delete any foreground picture object.
7. Save the real navigator.
8. Delete this translation navigator.
Hotspot1
NSrch
HotspotRectangle2
HotspotRectangle3
HotspotRectangle4
Favorite Topics
O=Lotus Notes
O=Lotus Notes
PURSAFO
|.:#U
O=Lotus Notes
CN=Lotus Notes Template Development/O=Lotus Notes
PURSAFO
Fde!f^^
$ViewMapDataset
$ViewMapLayout
b. Index
GraphicButton16e
TextBox1Contents
TextBox2Index
TextBox2Search
Rectangle2
Text3Favorite Topics
Text4Translators:
1. Translate and size as needed the text blocks in this navigator.
2. Choose View - Show and show this navigator.
3. Snap a picture of the navigator, starting exactly from the top left corner. Save the picture in the clipboard.
4. Open the equivalent real navigator, choose Design - Remove Graphic Background, and then choose Create - Graphic Background to use the picture you snapped.
5. Adjust the size of the hotspots as needed for the new language.
6. Delete any foreground picture object.
7. Save the real navigator.
8. Delete this translation navigator.
Hotspot1
NSrch
HotspotRectangle2
NCnts
HotspotRectangle3
HotspotRectangle4
Favorite Topics
O=Lotus Notes
O=Lotus Notes
PURSAFO
|.:#U
O=Lotus Notes
CN=Lotus Notes Template Development/O=Lotus Notes
PURSAFO
Fde!f^^
.%52A`u
0hkM2
$ViewMapDataset
$ViewMapLayout
c. Search
GraphicButton7
ULUkU
TextBox7Contents
TextBox8Indexd
TextBox10Searche
Rectangle4
Text11Favorite Topics
Text13Translators:
1. Translate and size as needed the text blocks in this navigator.
2. Choose View - Show and show this navigator.
3. Snap a picture of the navigator, starting exactly from the top left corner. Save the picture in the clipboard.
4. Open the equivalent real navigator, choose Design - Remove Graphic Background, and then choose Create - Graphic Background to use the picture you snapped.
5. Adjust the size of the hotspots as needed for the new language.
6. Delete any foreground picture object.
7. Save the real navigator.
8. Delete this translation navigator.
Rectangle5
Hotspot1
Hotspot2
HotspotRectangle4
HotspotRectangle6
Favorite Topics
O=Lotus Notes
O=Lotus Notes
PURSAFO
|.:#U
O=Lotus Notes
CN=Lotus Notes Template Development/O=Lotus Notes
PURSAFO
Fde!f^^
f1W;Fb
$ViewMapDataset
$ViewMapLayout
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. A hierarchical name in abbreviated form, or null if the property is undefined.
Defined in
Click here to see this topic
lotus.notes.Name
class
Click here to see this topic
Data type
String
Syntax
public String getAbbreviated()
throws NotesException
Click here to see this topic
See examples
Click here to see this topic
See related topics
Click here to see this topic
Canonical property
Click here to see this topic
Click here to see this topic
IsHierarchical property
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Abbreviates the contents of a text item.
Defined in
Click here to see this topic
lotus.notes.Item
Click here to see this topic
Syntax
public String abstractText(int maxlen, boolean dropvowels, boolean userdict)
throws NotesException
Parameters
int maxlen
The maximum length of the abbreviation
boolean dropvowels
Specify true if you want to drop vowels from the words in the item. Otherwise, specify false.
boolean userdict
Specify true if you want to use the table of abbreviations in NOTEABBR.TXT. Otherwise, specify false.i
Return value
String
The contents of the item, with vowels dropped and abbreviations substituted (if specified), then truncated to fit to
maxlen.
See related topics
Click here to see this topic
ValueLength property
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
The
Click here to see this topic
lotus.notes.International class
Click here to see this topic
represents the international (regional) settings of the operating environment. You can access the international settings through
Click here to see this topic
getInternational
Click here to see this topic
in lotus.notes.Session.
The following methods access the lotus.notes.International properties:
Click here to see this topic
getCurrencyDigits
Click here to see this topic
returns an int value containing the number of decimal digits for number format.
Click here to see this topic
getDecimalSep
Click here to see this topic
returns a String value containing the decimal separator for number format.4
Click here to see this topic
getT
housandsSep
Click here to see this topic
returns a String value containing the thousands separator for number format.
Click here to see this topic
sCurrencyZero
Click here to see this topic
returns a boolean value that is true if fractions have a zero before the decimal point for number format.
Click here to see this topic
getCurrencySymbol@
Click here to see this topic
returns a String value containing the symbol that indicates a number is currency.
Click here to see this topic
isCurrencySpace
Click here to see this topic
returns a boolean value that is true if currency format has a space between the currency symbol and the number.
Click here to see this topic
isCurrencySuffix
Click here to see this topic
returns a boolean value that is true if the currency symbol follows the number in currency format.
Click here to see this topic
getAMString
Click here to see this topic
returns a String value containing the AM designator.
Click here to see this topic
getPMString
Click here to see this topic
returns a String value containing the PM designator.
Click here to see this topic
getTimeSep
Click here to see this topic
returns a String value containing the character used to separate hours, minutes, and seconds.
Click here to see this topic
getTimeZone
Click here to see this topic
returns an int value containing the time zone.
Click here to see this topic
isTime24Hour
Click here to see this topic
returns a boolean value that is true if the time format is 24-hour.
Click here to see this topic
getDateSep
Click here to see this topic
returns a String value containing the character used to separate months, days, and years.
Click here to see this topic
getToday
Click here to see this topic
returns a String value containing the today designator for time-date format.o
Click here to see this topic
getTomorrow
Click here to see this topic
returns a String value containing the today designator for time-date format.
Click here to see this topic
getY
esterday
Click here to see this topic
returns a String value containing the today designator for time-date format.s
Click here to see this topic
isDateDMYu
Click here to see this topic
returns a boolean value that is true if the order of the date format is day-month-year.
Click here to see this topic
isDateMDY
Click here to see this topic
returns a boolean value that is true if the order of the date format is month-day-year.
Click here to see this topic
isDateYMDe
Click here to see this topic
returns a boolean value that is true if the order of the date format is year-month-day.
Click here to see this topic
isDST
Click here to see this topic
returns a boolean value that is true if the date format reflects daylight savings time.
Click here to see this topic
See examples
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Two classes provide access to agents: lotus.notes.AgentContext and lotus.notes.Agent.
lotus.notes.AgentContext
The
Click here to see this topic
lotus.notes.AgentContext class
Click here to see this topic
provides a means to access attributes of the current agent environment for programs that are running as agents. Call
Click here to see this topic
getAgentContext
Click here to see this topic
in lotus.notes.Session to get the current agent context; getAgentContext returns null if the program is not running as an agent.t
The following methods access the lotus.notes.AgentContext properties:o
Click here to see this topic
getCurrentAgentc
Click here to see this topic
returns a lotus.notes.Agent object representing the current agent.l
Click here to see this topic
getCurrentDatabase
Click here to see this topic
returns a lotus.notes.Database object representing the database containing current agent.
Click here to see this topic
getDocumentContext
Click here to see this topic
returns a lotus.notes.Document object representing the in-memory document when the agent starts.
Click here to see this topic
getEffectiveUserName
Click here to see this topic
returns a String value containing the user name that is in effect for the agent.
Click here to see this topic
getLastExitStatuse
Click here to see this topic
returns an int value containing the exit status for the last time the agent ran.
Click here to see this topic
getLastRun
Click here to see this topic
returns a lotus.notes.DateTime object representing the last time the agent ran.
Click here to see this topic
getSavedData
Click here to see this topic
returns a lotus.notes.Document object representing information stored between invocations of the agent.
Click here to see this topic
getUnprocessedDocumentsT
Click here to see this topic
returns a lotus.notes.DocumentCollection object representing the documents in the database that the agent considers "unprocessed."a
The
Click here to see this topic
unprocessedFTSearchE
Click here to see this topic
and
Click here to see this topic
unprocessedSearchn
Click here to see this topic
methods return lotus.notes.DocumentCollection objects representing "unprocessed" documents that meet search criteria. The
Click here to see this topic
updateProcessedDoc
Click here to see this topic
method marks documents as "processed" for future searches for new and modified documents.
lotus.notes.AgentT
The
Click here to see this topic
lotus.notes.Agent class
Click here to see this topic
represents an agent. You can access the current agent through _
Click here to see this topic
getCurrentAgentt
Click here to see this topic
in lotus.notes.AgentContex. You can access all agents in a database through N
Click here to see this topic
getAgents property
Click here to see this topic
in lotus.notes.Database.;
The following methods access the lotus.notes.Agent properties:
Click here to see this topic
getComment
Click here to see this topic
returns a String value containing the comment associated with the agent.r
Click here to see this topic
getCommonOwner
Click here to see this topic
returns a String value containing the common name of the user who last modified the agent.
Click here to see this topic
getLastRun
Click here to see this topic
returns a lotus.notes.DateTime object representing the last time the agent ran.
Click here to see this topic
getName
Click here to see this topic
returns a String value containing the name of the agent.
Click here to see this topic
getOwner
Click here to see this topic
returns a String value containing the name of the owner of the agent.
Click here to see this topic
getParentt
Click here to see this topic
returns a lotus.notes.Database object representing the database that contains the agent.d
Click here to see this topic
getQuery
Click here to see this topic
returns a String value containing the query used by the agent to select documents.
Click here to see this topic
getServerName
Click here to see this topic
returns a String value containing the name of the server on which the agent runs; r
Click here to see this topic
etServerName
Click here to see this topic
sets the server name to a string value (including * for all servers).
Click here to see this topic
isEnabledt
Click here to see this topic
returns true if the agent is enabled;
Click here to see this topic
set
Enabled
Click here to see this topic
enables (true) or disables (false) an agent.
Click here to see this topic
isPublic
Click here to see this topic
returns true if the agent is public.M
The Agent class contains a t
Click here to see this topic
remove methodn
Click here to see this topic
to remove the agent from the database; a
Click here to see this topic
run
methodU
Click here to see this topic
to run the agent; and a h
Click here to see this topic
save
methoda
Click here to see this topic
to save changes made by setServerName and setEnabled.
Click here to see this topic
See examples
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
The following methods access the lotus.notes.Session properties:
Click here to see this topic
getAddressBooks
Click here to see this topic
returns a java.util.Vector object of lotus.notes.Database objects representing all accessible public and personal address books, both local and remote.
Click here to see this topic
getAgentContext
Click here to see this topic
returns a lotus.notes.AgentContext object representing the current agent environment for programs being run as agents.
Click here to see this topic
getCommonUserName
Click here to see this topic
returns a String value containing the common name of the local server or user.
Click here to see this topic
getInternational
Click here to see this topic
returns a lotus.notes.International object representing the international settings in the operating environment.
Click here to see this topic
isOnServer
Click here to see this topic
returns true if the Notes environment is a server.
Click here to see this topic
getNotesVersionT
Click here to see this topic
returns a String value containing the version of the local server or user.
Click here to see this topic
getPlatform
Click here to see this topic
returns a String value containing the operating system platform.
Click here to see this topic
get
UserName
Click here to see this topic
returns a String value containing the full name of the local server or user.
Click here to see this topic
getF
UserNameObject
Click here to see this topic
returns a lotus.notes.Name object representing the name of the local server or user.
Click here to see this topic
See examples
Click here to see this topic
See related topics
Click here to see this topic
Accessing Notes agents
Click here to see this topic
{z_]s
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. The access control list for a database.
Defined in
Click here to see this topic
lotus.notes.Database
Click here to see this topic
Data typee
lotus.notes.ACL
Syntax
public lotus.notes.ACL getACL()
throws NotesExceptionl
Click here to see this topic
See examples
See related topics
Click here to see this topic
lotus.notes.ACL classc
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Causes an embedded object or object link to be loaded by OLE.
Defined in
Click here to see this topic
lotus.notes.EmbeddedObject
Click here to see this topic
Syntax
public int activate(boolean show)
throws NotesException
Parametere
boolean show
If True, the server application displays its user interface. If False, the server application hides its user interface.
Return value
The OLE handle to the object. Returns null if the embedded object or object link does not support OLE automation.
Usage
Scripts running on a server must set the
show
parameter to false.
This method raises an error if you invoke it on a lotus.notes.EmbeddedObject that is a file attachment.=
This method may or may not return a valid OLE handle for object links, depending upon the application used to create the object link.
Click here to see this topic
See examples
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Adds the certifier ID file to the address book.
Defined in
Click here to see this topic
lotus.n
otes.Registration class
Click here to see this topic
Syntax
public boolean addCertifierToAddressBook(String idfile)
throws NotesExceptionF
public boolean addCertifierToAddressBook(String idfile, String password, String location, String comment)
throws NotesExceptionb
Parameters
String idfiler
The certifer ID file to be added to the address book. Specify the complete path; for example, c:\notes\data\cert.id.
String password
The password for the certifier ID file.
String location
The contents of the location field in the address book record.
String comment
The contents of the comment field in the address book record.r
Return value
booleanH
True if the operation is successful; false otherwise.r
Click here to see this topic
See examples
See related topics
Click here to see this topic
addServerToAddressbook method
Click here to see this topic
Click here to see this topic
addUserProfile method
Click here to see this topic
Click here to see this topic
addUserToAddressBook method
Click here to see this topic
Click here to see this topic
CertifierIDFile property
Click here to see this topic
bF';n^s
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Appends one or more new lines (carriage returns) to the end of a rich text item.
Defined in
Click here to see this topic
lotus.notes.RichTextItem
Click here to see this topic
Syntax
public void addNewLine()
throws NotesException
public void addNewLine(int count)
throws NotesException
public void addNewLine(int count, boolean newparagraph)
throws NotesException
Parameters
int count
The number of new lines to append.
boolean newparagraph
If True, forces the new line to be a paragraph separator. If False, the new line is added, but does not force a new paragragh. True by default.B
Click here to see this topic
See examples
See related topics
Click here to see this topic
addTab methodn
Click here to see this topic
Click here to see this topic
appendText methode
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. The address books, both public and personal, that are known to the current session.
Defined in
Click here to see this topic
lotus.notes.Session
Click here to see this topic
Data type
java.util.Vector; elements are
Click here to see this topic
lotus.notes.Database
Click here to see this topic
Syntax
public java.util.Vector getAddressBooks()
throws NotesException
Usagel
To find out if an address book is public or personal, use the
Click here to see this topic
isPublicAddressBook
Click here to see this topic
and n
Click here to see this topic
isPrivateAddressBook
Click here to see this topic
properties of lotus.notes.Database.
If the program runs on a workstation, both public and personal address books are included. If the program runs on a server, only public address books on the server are included.
Click here to see this topic
See examples
Click here to see this topic
See related topics
Click here to see this topic
Accessing session properties
Click here to see this topic
Click here to see this topic
lotus.notes.Database class
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Adds a role to an ACL.
Defined in
Click here to see this topic
lotus.notes.ACL
Click here to see this topic
Syntax
public void addRole(String name)
Parameter
String name
The name of the new role. Do not put parentheses or square brackets around the name.
Click here to see this topic
See examples
See related topics
Click here to see this topic
deleteRole methode
Click here to see this topic
Click here to see this topic
disableRole method
Click here to see this topic
Click here to see this topic
enableRole methodi
Click here to see this topic
Click here to see this topic
isRoleEnabled method
Click here to see this topic
Click here to see this topic
Roles property
Click here to see this topic
Click here to see this topic
Roles property
Click here to see this topic
Jz aos
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Adds a server to the address book.
Defined in
Click here to see this topic
NotesRegistration class
Click here to see this topic
Syntax
public boolean addServerToAddressBook(String idfile, String server, String domain)
The ID file for the user to be added to the address book. Specify the full path, for example, c:\notes\data\cert.id.
String fullname
The user's full name.
String lastn
The user's last name.
String userpw
The user's password for the specified ID file.
String firstn
The user's first name.
String middle
The user's middle name.
String mailserv
The full name of the user's mail server.
String mailfilepath
The full mail pathname for the specified ID file.
String fwdaddr
The user's forwarding mail address.e
String location
The contents of the location field in the address book record.
String comment
The contents of the comment field in the address book record.
Return value
booleany
True if the operation is successful; false otherwise.@
Click here to see this topic
See examples
See related topics
Click here to see this topic
addCertifierToAddressbook method
Click here to see this topic
Click here to see this topic
addServerToAddressbook methodD
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Increments a date-time by the number of days you specify.
Defined in
Click here to see this topic
lotus.notes.DateTime
Click here to see this topic
Syntax
public void adjustDay(int adjust)
throws NotesException
public void adjustDay(int adjust, boolean localzone)
throws NotesException
Parameter
int adjust
The number of days by which to increment the date-time. Can be positive or negative.
boolean localzone
Specify true to further adjust the time for daylight savings if the adjustment crosses the boundary and daylight savings is in effect. Specify false or omit this parameter to not further adjust the time for daylight savings. The adjustment is such that adding or subtracting in day increments yields the same time in the new day.
Click here to see this topic
See examples
Click here to see this topic
See related topics
Click here to see this topic
adjustHour method
Click here to see this topic
Click here to see this topic
adjustMinute method
Click here to see this topic
Click here to see this topic
adjustMonth method
Click here to see this topic
Click here to see this topic
adjustSecond method
Click here to see this topic
Click here to see this topic
adjustYear method
Click here to see this topic
R<;_-DZ#`s
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Increments a date-time by the number of hours you specify.
Defined in
Click here to see this topic
lotus.notes.DateTime
Click here to see this topic
Syntax
public void adjustHour(int adjust)
throws NotesException
public void adjustHour(int adjust, boolean localzone)
throws NotesException
Parametero
int adjust
The number of hours by which to increment the date-time. Can be positive or negative.
boolean localzone
Specify true to further adjust the time for daylight savings if the adjustment crosses the boundary and daylight savings is in effect. Specify false or omit this parameter to not further adjust the time for daylight savings. The adjustment is such that adding or subtracting in day increments yields the same time in the new day.
Usage
If the lotus.notes.DateTime object consists of only a date component, this method has no effect.
The number of hours by which you increment a lotus.notes.DateTime object can cause the date component to be adjusted, too. For example, if t
adjust
is 24, the date component changes to the next calendar day.
Click here to see this topic
See examples
Click here to see this topic
See related topics
Click here to see this topic
adjustDay method
Click here to see this topic
Click here to see this topic
adjustMinute methode
Click here to see this topic
Click here to see this topic
adjustMonth method
Click here to see this topic
Click here to see this topic
adjustSecond methodc
Click here to see this topic
Click here to see this topic
adjustYear method
Click here to see this topic
R<;_-DZ#`s
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Increments a date-time by the number of minutes you specify.
Defined in
Click here to see this topic
lotus.notes.DateTime
Click here to see this topic
Syntax
public void adjustMinute(int adjust)
throws NotesException
public void adjustMinute(int adjust, boolean localzone)
throws NotesException
Parameter
int adjust
The number of minutes by which to increment the date-time. Can be positive or negative.B
boolean localzone
Specify true to further adjust the time for daylight savings if the adjustment crosses the boundary and daylight savings is in effect. Specify false or omit this parameter to not further adjust the time for daylight savings. The adjustment is such that adding or subtracting in day increments yields the same time in the new day.
UsageT
If the lotus.notes.DateTime object consists of only a date component, this method has no effect.
The number of minutes by which you increment a lotus.notes.DateTime object can cause the date component to be adjusted, too. For example, if G
adjust
is 1440, the date component changes to the next calendar day.
Click here to see this topic
See examples
Click here to see this topic
See related topics
Click here to see this topic
adjustDay method
Click here to see this topic
Click here to see this topic
adjustHour method
Click here to see this topic
Click here to see this topic
adjustMonth method
Click here to see this topic
Click here to see this topic
adjustSecond methodP
Click here to see this topic
Click here to see this topic
adjustYear method
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Increments a date-time by the number of months you specify.
Defined in
Click here to see this topic
lotus.notes.DateTime
Click here to see this topic
Syntax
public void adjustMonth(int adjust)
throws NotesExceptionn
public void adjustMonth(int adjust, boolean localzone)
throws NotesException
Parameter
int adjust
The number of months by which to increment the date-time. Can be positive or negative.
boolean localzonel
Specify true to further adjust the time for daylight savings if the adjustment crosses the boundary and daylight savings is in effect. Specify false or omit this parameter to not further adjust the time for daylight savings. The adjustment is such that adding or subtracting in day increments yields the same time in the new day.
Usage
The number of months by which you increment a lotus.notes.DateTime object can cause the year to be incremented. For example, if
adjust
is 12, the date component changes to the next calendar year.2
Click here to see this topic
See examples
Click here to see this topic
See related topics
Click here to see this topic
adjustDay method
Click here to see this topic
Click here to see this topic
adjustHour method
Click here to see this topic
Click here to see this topic
adjustMinute method
Click here to see this topic
Click here to see this topic
adjustSecond method
Click here to see this topic
Click here to see this topic
adjustYear method
Click here to see this topic
R<;_-DZ#`s
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Increments a date-time by the number of seconds you specify.
Defined in
Click here to see this topic
lotus.notes.DateTime
Click here to see this topic
Syntax
public void adjustSecond(int adjust)
throws NotesException
public void adjustSecond(int adjust, boolean localzone)
throws NotesException
Parameter
int adjust
The number of seconds by which to increment the date-time. Can be positive or negative.
boolean localzone
Specify true to further adjust the time for daylight savings if the adjustment crosses the boundary and daylight savings is in effect. Specify false or omit this parameter to not further adjust the time for daylight savings. The adjustment is such that adding or subtracting in day increments yields the same time in the new day.a
Usage
If the lotus.notes.DateTime object consists of only a date component, this method has no effect.
Click here to see this topic
See examples
Click here to see this topic
See related topics
Click here to see this topic
adjustDay method
Click here to see this topic
Click here to see this topic
adjustHour method
Click here to see this topic
Click here to see this topic
adjustMinute method
Click here to see this topic
Click here to see this topic
adjustMonth method
Click here to see this topic
Click here to see this topic
adjustYear method
Click here to see this topic
R<;_-DZ#`s
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Increments a date-time by the number of years you specify.
Defined in
Click here to see this topic
lotus.notes.DateTime
Click here to see this topic
Syntax
public void adjustYear(int adjust)
throws NotesException
public void adjustYear(int adjust, boolean localzone)
throws NotesException
Parameter
int adjust
The number of years by which to increment the date-time. Can be positive or negative.
boolean localzone
Specify true to further adjust the time for daylight savings if the adjustment crosses the boundary and daylight savings is in effect. Specify false or omit this parameter to not further adjust the time for daylight savings. The adjustment is such that adding or subtracting in day increments yields the same time in the new day.
Usage
The number of years by which you increment a lotus.notes.DateTime object can cause the century to change. If this happens, the year is represented with four digits instead of two, such as 08/18/2001.m
Click here to see this topic
See examples
Click here to see this topic
See related topics
Click here to see this topic
adjustDay method
Click here to see this topic
Click here to see this topic
adjustHour methode
Click here to see this topic
Click here to see this topic
adjustMinute method
Click here to see this topic
Click here to see this topic
adjustMonth method
Click here to see this topic
Click here to see this topic
adjustSecond methode
Click here to see this topic
R<;_-DZ#`s
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. The administration management domain name (ADMD) associated with the name, or null if the property is undefined.
Defined in
Click here to see this topic
lotus.notes.Name
class
Click here to see this topic
Data type(
String
Syntax
public String getADMD()
throws NotesException
Click here to see this topic
See examples
Click here to see this topic
See related topics
Click here to see this topic
PRMD property
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. Represents the agent environment of the current program, if an agent is running it.
Defined in
Click here to see this topic
lotus.notes.Sessioni
Click here to see this topic
Data typeg
Click here to see this topic
lotus.notes.AgentContext
Click here to see this topic
Syntax
public lotus.notes.AgentContext getAgentContext()
throws NotesExceptiono
Usage
If the current program is not running from an agent, this property returns null.
See the
Click here to see this topic
lotus.notes.AgentContext
Click here to see this topic
class for descriptions and examples.
See related topics
Click here to see this topic
Accessing Notes agents
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. All of the agents in a database.
Defined in
Click here to see this topic
lotus.notes.Database
Click here to see this topic
Data typee
Object of type java.util.Vector whose elements are objects of type e
Click here to see this topic
lotus.notes.Agente
Click here to see this topic
Syntax
public java.util.Vector getAgents()
throws NotesExceptione
Usagea
Each element in the array is a lotus.notes.Agent object. If the script runs on the workstation, the array includes public agents and personal agents that belong to the current user. If the script runs on a server, the array includes only public agents.
Click here to see this topic
See examples
See related topics
Click here to see this topic
Accessing Notes agents
Click here to see this topic
Click here to see this topic
lotus.notes.Agent class
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. The aliases of a form.
Defined in
Click here to see this topic
lotus.notes.Form
Click here to see this topic
Data type
Object of type java.util.Vector whose elements are of type java.lang.Stringu
Syntax
public java.util.Vector getAliases()
throws NotesException
Usage
When you use GetForm, this property returns all but the first in the list of all the form's names. The Names property returns the first name in the list.
IsEmpty is true for this property if the form has no aliases.w
Click here to see this topic
See examples
See related topics
Click here to see this topic
Name Property@
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. The aliases of a view.
Defined in
Click here to see this topic
lotus.notes.View
Click here to see this topic
Data typei
Object of type java.util.Vector whose elements are of type java.lang.String
Syntax
public java.util.Vector getAliases()
throws NotesException
Usagel
When you use GetView, this property returns all but the first in the list of all the view's names. The Names property returns the first name in the list.
For example, for the name "All\By review date|Review," the property returns "Review."
Click here to see this topic
See examples
See related topics
Click here to see this topic
Name property
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. An unsorted collection containing all the documents in a database.
Defined in
Click here to see this topic
lotus.notes.Database
Click here to see this topic
Data typei
Click here to see this topic
lotus.notes.DocumentCollection
Click here to see this topic
Syntax
public lotus.notes.DocumentCollection getAllDocuments()
throws NotesExceptiong
Usage)
Since many databases contain large numbers of documents, you may use the FTSearch or Search methods instead of the AllDocuments property. Both methods return a smaller collection of documents that meet specific criteria. Using AllDocuments is, however, more efficient than using the Search method with an @All formula.
Click here to see this topic
See examples
See related topics
Click here to see this topic
FTSearch method
Click here to see this topic
Click here to see this topic
search method
Click here to see this topic
Click here to see this topic
UnprocessedDocuments property
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. The string that denotes AM time, for example, "AM" in English.
Defined in
Click here to see this topic
lotus.notes.International Class
Click here to see this topic
Data type
Object of type java.lang.StringY
Syntax
public String getAMString()
throws NotesException
Click here to see this topic
See examples
Click here to see this topic
See related topics
Click here to see this topic
Accessing international settings
Click here to see this topic
Click here to see this topic
IsTime24Hour property
Click here to see this topic
Click here to see this topic
PMString propertyP
Click here to see this topic
Click here to see this topic
TimeSep property
Click here to see this topic
Click here to see this topic
TimeZone property
Click here to see this topic
}%ALh:ts
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Given a database, view, or document to link to, adds a link to the end of a rich text item.e
Defined in
Click here to see this topic
lotus.notes.RichTextItem
Click here to see this topic
Syntax
public void appendDocLink(lotus.notes.Document doc)
throws NotesExceptionc
public void appendDocLink(lotus.notes.Document doc, String comment)
throws NotesException
Parameters
lotus.notes.Document doc
Click here to see this topic
lotus.notes.Database
Click here to see this topic
Click here to see this topic
lotus.notes.View
Click here to see this topic
, or
Click here to see this topic
lotus.notes.Document
Click here to see this topic
. The database, view, or document to which you want to create a link.i
String comment
The text that appears when a user presses and holds the mouse pointer over the link.
Click here to see this topic
See examples
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Creates a new item on a document and sets the item value.
Defined in
Click here to see this topic
lotus.notes.Document
Click here to see this topic
Syntax
public lotus.notes.Item appendItemValue(String name)
throws NotesException
public lotus.notes.Item appendItemValue(String name, int value)
throws NotesException
public lotus.notes.Item appendItemValue(String name, double value)
throws NotesException
public lotus.notes.Item appendItemValue(String name, Object value)
throws NotesException
Parameters
String name
String. The name of the new item.e
int valuee
Integer. The value of the new item.
double value
Doubler. The value of the new item.@
Object value
The value of the new item. The data type of the new item depends upon the data type of the
value
that you place in it.
Data type of value
Resulting lotus.notes.Item
java.lang.String
Text item containing
value
java.util.Vector with java.lang.String elementsP
Text item containing each element of
value
integer
Number item containing
value
java.util.Vector with integer elements
Number item containing each element of o
value-
lotus.notes.DateTime
Date-time item containing the date-time represented by the object
java.util.Vector with lotus.notes.DateTime elements
Date-time item containing each element of
value
lotus.notes.Item
Item whose data type matches the lotus.notes.Item type and whose value(s) match the lotus.notes.Item value(s)
Return value
lotus.notes.Item
The new item.
Usagen
To keep the new item in the document, you must call the Save method after calling AppendItemValue.
If the document already has an item called
ame,
AppendItemValue does not replace it. Instead, it creates another item of the same name and gives it the value you specify.
The IsSummary property of the new item defaults to true, which means that the item value can be displayed in a view or folder.
Click here to see this topic
See examples
See related topics
Click here to see this topic
getItemValue method
Click here to see this topic
Click here to see this topic
hasItem method
Click here to see this topic
Click here to see this topic
lotus.notes.Item class
Click here to see this topic
Click here to see this topic
replaceItemValue method
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Appends the contents of one rich text item to the end of another rich text item.
Defined in
Click here to see this topic
lotus.notes.RichTextItem
Click here to see this topic
Syntax
public void appendRTItem(lotus.notes.RichTextItem item)
throws NotesExceptionc
Parameter
lotus.notes.RichTextItem item
The item to be appended.
Click here to see this topic
See examples
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Appends a style to the end of a rich text item. Text following the style is rendered using that style's attributes until another style is appended.
Defined in
Click here to see this topic
lotus.notes.RichTextItem
Click here to see this topic
Syntax
public void appendStyle(lotus.notes.RichTextStyle style)
throws NotesException
Parameter
lotus.notes.RichTextStyle style
The style to be appended.
UsageN
This method does not affect text appended by o
Click here to see this topic
appendRTItem
Click here to see this topic
Click here to see this topic
See examples
See related topics
Click here to see this topic
createRichTextStyle method
Click here to see this topic
Click here to see this topic
lotus.notes.RichTextStyle classd
Click here to see this topic
]6VGA
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Appends text to the end of a rich text item. The text is rendered with the current style of the item (such as bold, or italicized).
Defined in
Click here to see this topic
lotus.notes.RichTextItem
Click here to see this topic
Syntax
public void appendText(String text)
throws NotesExceptione
Parameters
String text
The text to append.
Click here to see this topic
See examples
See related topics
Click here to see this topic
addNewLine method
Click here to see this topic
Click here to see this topic
addTab method
Click here to see this topic
Click here to see this topic
getFormattedText methodV
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
For an item that's a text list, adds a new value to the item without erasing any existing values.
Defined in
Click here to see this topic
lotus.notes.Item
Click here to see this topic
Syntax
public void appendToTextList(String value)
throws NotesException
public void appendToTextList(java.util.Vector values)
throws NotesExceptions
Parametere
String value
The string you want to add to the item. Each vector element is an object of type java.lang.String.
java.util.Vector values.
The string(s) you want to add to the item. Each vector element is an object of type java.lang.String.
Click here to see this topic
See examples
See related topics
Click here to see this topic
appendItemValue method
Click here to see this topic
Click here to see this topic
replaceItemValue method
Click here to see this topic
Click here to see this topic
Values property
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. The names of the people who have saved a document.
Defined in
Click here to see this topic
lotus.notes.Document
Click here to see this topic
Data type?
Object of type java.util.Vector whose elements are of java.lang.String
Syntax
public java.util.Vector getAuthors()
throws NotesException
Usagee
If a name is hierarchical, this property returns the fully distinguished name.
This property does
not
return the names of people who have permission to edit a document (as found in an item of type Authors). Therefore, the people returned by the Authors property and the people listed in an Authors item may differ.
Click here to see this topic
See examples
See related topics
Created property
H_CREATED_PROPERTY_DOC_JAVA
IsAuthors Property
H_ISAUTHORS_PROPERTY_JAVA in lotus.notes.Item<
LastModified property
H_LASTMODIFIED_PROPERTY_DOC_JAVA
Signer propertya
H_SIGNER_PROPERTY_JAVA
Verifier property
H_VERIFIER_PROPERTY_JAVA
See related topics
Click here to see this topic
Created property
Click here to see this topic
Click here to see this topic
IsAuthors property
Click here to see this topic
Click here to see this topic
LastModified property
Click here to see this topic
Click here to see this topic
Signer property
Click here to see this topic
Click here to see this topic
Verifier property
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-write. Indicates whether the front-end view is automatically updated each time a change occurs in the back-end.
Defined in
Click here to see this topic
lotus.notes.View
Click here to see this topic
Data type
boolean
Syntax
public boolean isAutoUpdate()
throws NotesException
public void setAutoUpdate(boolean flag)
throws NotesException
Legal values
True
The front-end view is automatically updated (default)
False
The front-end view is not automatically updated
Usaget
You may want to set this value to false to save time. If this value is false, changes are posted once when the script ends.
Click here to see this topic
See examples
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-Write. Bold rich text attribute.V
Defined in
Click here to see this topic
lotus.notes.
RichTextStyles
Click here to see this topic
Data typee
intH
Syntax
public int getBold()
throws NotesException
public void setBold(int value)
throws NotesException
Legal values
YES for bold
NO for non-bold
STYLE_NO_CHANGE to maintain previous state
Click here to see this topic
See examples
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. A hierarchical name in canonical form, or null if the property is undefined.
Defined in
Click here to see this topic
lotus.notes.Name
class
Click here to see this topic
Data type
String
Syntax
public String getCanonical()
throws NotesException
Click here to see this topic
See examples
Click here to see this topic
See related topics
Click here to see this topic
Abbreviated property
Click here to see this topic
Click here to see this topic
IsHierarchical property
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-Write. The categories under which a database appears in the Database Library. Multiple categories are separated by a comma or semicolon.A
Defined in
Click here to see this topic
lotus.notes.Database
Click here to see this topic
Data type
Object of type java.lang.Stringh
Syntax
public String getCategories()
throws NotesException
public void setCategories(String categories)
throws NotesException
Click here to see this topic
See examples
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-Write. The complete file specification of the certifier ID to use when creating IDs.
Defined in
Click here to see this topic
lotus.notes.Registration class
Click here to see this topic
Data typei
String
Syntax
public String getCertifierIDFile()
throws NotesException
public void setCertifierIDFile(String file)
throws NotesExceptioni
Usage
Specify the complete path, for example, c:\notes\data\cert.id.
Click here to see this topic
See examples
See related topics
Click here to see this topic
RegistrationServer property
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. The name of the application which created an object.*
Defined in
Click here to see this topic
lotus.notes.EmbeddedObject
Click here to see this topic
Data typer
Object of type java.lang.String
Syntax
public String getClassName()
throws NotesException
Usage
For file attachments, this property returns null.
Click here to see this topic
See examples
See related topics
Click here to see this topic
Name property
Click here to see this topic
Click here to see this topic
Source property
Click here to see this topic
Click here to see this topic
Type propertyR
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Clears the full text search filtering on a view.
Defined in
Click here to see this topic
lotus.notes.View
Click here to see this topic
Syntax
public void clear()
throws NotesException
Click here to see this topic
See examples
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Closes a log.
Defined in
Click here to see this topic
lotus.notes.Log
Click here to see this topic
Syntax
public void close()
throws NotesExceptionE
Usage
If you are logging to a mail message, Close sends the mail message to its recipient(s).:
Click here to see this topic
See examples
Click here to see this topic
See related topics
Click here to see this topic
Making a Notes log
Click here to see this topic
Click here to see this topic
openMailLog method
Click here to see this topic
2yFyts
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. All the columns in a view.e
Defined in
Click here to see this topic
lotus.notes.View
Click here to see this topic
Data type
Object of type java.util.Vector whose elements are objects of type t
Click here to see this topic
lotus.notes.ViewColumn
Click here to see this topic
Syntax
public java.util.Vector getColumns()
throws NotesException
Usages
The order of lotus.notes.ViewColumn objects in the vector corresponds to the order of the columns in the view, from left to right.
Click here to see this topic
See examples
See related topics
Click here to see this topic
ColumnValues property
Click here to see this topic
Click here to see this topic
lotus.notes.ViewColumn class
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. An array of values, each element of which corresponds to a column value in the document's parent view. The first value in the array is the value that appears in the view's first column for the document, the second value is the one that appears in the second column, and so on. The value of each element of the array is the result of the corresponding column's formula and the items on the current document. Some elements in the array might have no value.
If you do not access the document through a view, this property has no value.r
Defined in
Click here to see this topic
lotus.notes.Document
Click here to see this topic
Data typet
Object of type java.util.Vector whose elements are objects of type java.lang.Object
Syntax
public java.util.Vector getColumnValues()
throws NotesExceptiona
Usageo
If a document contains an item that's visible in a view, the ColumnValues property provides efficient access to its value. Accessing the item's value directly is less efficient.o
This property returns a value for each column in the parent view, regardless of whether the column is considered "Responses-only." For example, if the third column in a view is responses-only, doc.GetColumnValues( 2 ) evaluates the column formula for the document and returns a result, whether the document is a response or not.
Click here to see this topic
See examples
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. The comment that describes an agent, as entered by the agent's designer.
Defined in
Click here to see this topic
lotus.notes.Agentn
Click here to see this topic
Data type
String
Syntax
public String getComment()
throws NotesException
Click here to see this topic
See examples
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. The common name of the person who last modified and saved an agent (the agent's owner). If the owner has a hierarchical name, only the common name is returned.
Defined in
Click here to see this topic
lotus.notes.Agent
Click here to see this topic
Data type
String
Syntax
public String getCommonOwner()
throws NotesException
Usage
If the owner's name is flat (non-hierarchical), the CommonOwner name is the same as the Owner name.
Click here to see this topic
See examples
Click here to see this topic
See related topics
Click here to see this topic
Owner property
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. The common name portion of the current user's name.
Defined in
Click here to see this topic
lotus.notes.Sessions
Click here to see this topic
Data type
String
Syntax
public String getCommonUserName()
throws NotesExceptione
Usage
The user is the user or server owning the local Notes directory.
If the user's name is flat (non-hierarchical), CommonUserName is the same as UserName.
Click here to see this topic
See examples
Click here to see this topic
See related topics
Click here to see this topic
Accessing session properties
Click here to see this topic
Click here to see this topic
EffectiveUserName property
Click here to see this topic
Click here to see this topic
lotus.notes.Name class
Click here to see this topic
Click here to see this topic
UserName property
Click here to see this topic
Click here to see this topic
UserNameObject propertyt
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. The common name component of a hierarchical name (CN=), or the entire name if it is flat.
Defined in
Click here to see this topic
lotus.notes.Name
class
Click here to see this topic
Data type
String
Syntax
public String getCommon()
throws NotesException
Click here to see this topic
See examples
Click here to see this topic
See related topics
Click here to see this topic
Country property
Click here to see this topic
Click here to see this topic
Organization property
Click here to see this topic
Click here to see this topic
OrgUnit1 property
Click here to see this topic
Click here to see this topic
OrgUnit2 property
Click here to see this topic
Click here to see this topic
OrgUnit3 property|
Click here to see this topic
Click here to see this topic
OrgUnit4 property
Click here to see this topic
V\W4s
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Compacts a local database.
Defined in
Click here to see this topic
lotus.notes.Database
Click here to see this topic
Syntax
public int compact()
throws NotesException
Return value
intA
The difference in bytes between the size of the database before and after compacting.
Usage
This method throws an exception if the database is not local.M
Click here to see this topic
See examples
See related topics
Click here to see this topic
PercentUsed property
Click here to see this topic
Click here to see this topic
Size property
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
A Java program using the Notes classes has the following requirements:
Lotus Domino (server or client) must be installed on the machine for both compilation and execution.
The CLASSPATH environment variable must include Notes.jar in the Notes directory. For example:
set CLASSPATH=.;c:\notes\Notes.jar
The program must import the lotus.notes package.
A stand-alone program must use the
Click here to see this topic
lotus.notes.NotesThread classO
Click here to see this topic
, which extends java.lang.Thread. You can either extend NotesThread or implement the Runnable interface. If you extend NotesThread, the entry point to the functional code must be public void runNotes(). If you implement Runnable, the entry point must be public void run().
A Domino or Notes agent program must extend the lotus.notes.AgentBase class, which extends lotus.notes.NotesThread. The class that contains the agent code must be public. The entry point to the functional code must be public void NotesMain().
The lotus.notes.Session class is the root of the Notes back-end object containment hierarchy. For stand-alone programs, use the method newInstance() to create a Session object. For agents, use the AgentBase method getSession().
System.exit must not be used to terminate a program using the NotesThread class (and by extension the AgentBase class). In an agent, System.exit throws SecurityException. In a stand-alone program, System.exit may cause corruption problems.
For foreground agents, System.out and System.err output goes to the Java debug console. For locally scheduled agents, System.out and System.err output goes to the Notes log.
For output to Web browsers, you must assign a java.io.PrintWriter object with the getAgentOutput() method of lotus.notes.AgentBase, and write using the println method of the PrintWriter object.
Click here to see this topic
See examples
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Validates a document by executing the default value, translation, and validation formulas, if any are defined in the document form.
Defined in
Click here to see this topic
lotus.notes.Document
Click here to see this topic
Syntax
public boolean computeWithForm(boolean dodatatypes, boolean raiseerror)
throws NotesExceptionP
Parameters
boolean dodatatypesn
The method ignores this parameter. Specify either true or false.
boolean raiseerror
If true, an error is raised if the validation fails. If false, no error is raised; instead, the method returns false if validation fails.
Return value
boolean
True
There are no errors on the document.
False
There are errors on the document.
Usage_
Notes determines the form for the document using:
1. The form stored in the document, if any.
2. The contents of the Form item, if no form is stored in the document.
3. The database default form, if the document does not have a Form item.
In the Notes user interface, you must use a form to create a document. The document must meet the form's requirements for input validation, and the user interface informs you if the document does not meet these requirements. With the Notes classes, you can create a document without a form. The ComputeWithForm method provides a means of checking that the data you've placed on a document meets a form's requirements, although (unlike in the user interface) you can still save a document if the ComputeWithForm returns false or raises an error.
Click here to see this topic
See examples
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Given a value, checks if the value matches at least one of the item's values exactly.h
Defined in
Click here to see this topic
lotus.notes.Item
Click here to see this topic
Syntax
public boolean containsValue(Object value)
throws NotesException
Parameter
Object value
String, number, or
Click here to see this topic
lotus.notes.DateTime
Click here to see this topic
value.
Return Values
True
The value matches one of the values in the item.
False
The value does not match any of the values in the item.
Usage
This method
cannot
search a text item to see if it contains a specific word. Rather, it's intended to check a text list, number list, or date-time range to see if one of the values in the list or range matches
value.
If
value
is a distinguished name, and if the item contains Notes user names, the distinguished name matches the common version of the hierarchical name.(
Click here to see this topic
See examples
See related topics
Click here to see this topic
appendToTextList method
Click here to see this topic
Click here to see this topic
Values property
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Changes the TimeZone and IsDST properties as specified.
Defined in
Click here to see this topic
lotus.notes.DateTime
Click here to see this topic
Syntax
public void convertToZone(int newzone, boolean dst)
throws NotesException
Parameters
int newzone
A time zone 0-15.
boolean dst)
Indicates whether daylight savings is in effect (true) or not (false).
UsageB
These changes affect the ZoneTime property.
The GMTTime and the LocalTime properties do not change.t
Click here to see this topic
See examples
Click here to see this topic
See related topics
Click here to see this topic
IsDST property
Click here to see this topic
Click here to see this topic
IsDST property
Click here to see this topic
Click here to see this topic
ZoneTime property
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Given a destination document, copies all of the items in the current document into the destination document. The item names are unchanged.
Defined in
Click here to see this topic
lotus.notes.Document
Click here to see this topic
Syntax
public void copyAllItems(lotus.notes.Document doc, boolean replace)
throws NotesException
Parameters
lotus.notes.Document
The destination document.u
boolean replace
If true, the items in the destination document are replaced. If false (default), the items in the destination document are addended.
Click here to see this topic
See examples
See related topics
Click here to see this topic
appendItemValue method
Click here to see this topic
Click here to see this topic
copyItem method>
Click here to see this topic
Click here to see this topic
copyItemToDocument method
Click here to see this topic
Click here to see this topic
getFirstItem methodV
Click here to see this topic
Click here to see this topic
Items property
Click here to see this topic
Click here to see this topic
lotus.notes.Item class
Click here to see this topic
Click here to see this topic
replaceItemValue methodt
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Copies an item to a specified document.c
Defined in
Click here to see this topic
lotus.notes.Item
Click here to see this topic
Syntax
public lotus.notes.Item copyItemToDocument(lotus.notes.Document doc)
throws NotesException
public lotus.notes.Item copyItemToDocument(lotus.notes.Document doc, String newName)
throws NotesException
Parameters
lotus.notes.Document doc
The document on which to create the item.h
String newname
The name of the new item. Specify an empty string ("") if you want to keep the name of the original item.e
Return value
lotus.notes.Item
The new item.E
UsageJ
When you call this method using a lotus.notes.RichTextItem object, file attachments, embedded objects, and object links that are contained within the rich text item are i
not
copied to the destination document.n
Click here to see this topic
See examples
See related topics
Click here to see this topic
copyAllItems method
Click here to see this topic
Click here to see this topic
copyItem method
Click here to see this topic
Click here to see this topic
lotus.notes.Document class
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Given an item, copies it into the current document and optionally assigns the copied item a new name.
Defined in
Click here to see this topic
lotus.notes.Document
Click here to see this topic
Syntax
public lotus.notes.Item copyItem(lotus.notes.Item item)
throws NotesException
public lotus.notes.Item copyItem(lotus.notes.Item item, String newname)
throws NotesExceptionn
Parameters
lotus.notes.Item itemo
The item, usually from another document, that you want to copy.a
String newname
The name to assign to the copied item. Specify an empty string ("") to retain the item's existing name.
Return value
lotus.notes.Item
A copy of the specified
item
parameter, identical except for its
newname
Click here to see this topic
See examples
See related topics
Click here to see this topic
appendItemValue method
Click here to see this topic
Click here to see this topic
copyAllItems methods
Click here to see this topic
Click here to see this topic
copyItemToDocument methodc
Click here to see this topic
Click here to see this topic
getFirstItem method
Click here to see this topic
Click here to see this topic
hasItem method
Click here to see this topic
Click here to see this topic
lotus.notes.Item class
Click here to see this topic
Click here to see this topic
removeItem methodt
Click here to see this topic
Click here to see this topic
replaceItemValue method
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Copies a document into the specified database.
Defined in
Click here to see this topic
lotus.notes.Document
Click here to see this topic
Syntax
public lotus.notes.Document copyToDatabase(lotus.notes.Database db)
throws NotesException
Parameter
lotus.notes.Database db
The database in which you want a copy of the document.
Return value
lotus.notes.Document
The new document in the specified database.
Click here to see this topic
See examples
See related topics
Click here to see this topic
copyAllItems method
Click here to see this topic
Click here to see this topic
lotus.notes.Database class
Click here to see this topic
Click here to see this topic
remove methodt
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. The country component of a hierarchical name (C=), or null if the property is undefined.
Defined in
Click here to see this topic
lotus.notes.Name
class
Click here to see this topic
Data type
String
Syntax
public String getCountry()
throws NotesException
Click here to see this topic
See examples
Click here to see this topic
See related topics
Click here to see this topic
Common property
Click here to see this topic
Click here to see this topic
Keyword property
Click here to see this topic
Click here to see this topic
Organization property
Click here to see this topic
Click here to see this topic
OrgUnit1 property
Click here to see this topic
Click here to see this topic
OrgUnit2 property
Click here to see this topic
Click here to see this topic
OrgUnit3 property
Click here to see this topic
Click here to see this topic
OrgUnit4 property
Click here to see this topic
V\W4s
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. The number of documents in a collection.n
Defined in
Click here to see this topic
lotus.notes.DocumentCollection
Click here to see this topic
Data typeo
int{
Syntax
public int getCount()
throws NotesExceptionE
Click here to see this topic
See examples
See related topics
Click here to see this topic
getNthDocument method
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Creates an entry in the ACL with the name and level that you specify.
Defined in
Click here to see this topic
lotus.notes.ACLo
Click here to see this topic
Syntax
public lotus.notes.ACLEntry createACLEntry(String name, int level)
throws NotesException
Parameters
String name
The name of the person, group, or server for whom you want to create an entry in the ACL.
int levelt
The level you want to assign to this person, group, or server in the ACL. May be any of the following (defined in lotus.notes.Database):
ACLLEVEL_NOACCESS
No access
ACLLEVEL_DEPOSITOR
Depositor access
ACLLEVEL_READER
Reader access
ACLLEVEL_AUTHOR
Author accessa
ACLLEVEL_EDITOR
Editor access
ACLLEVEL_DESIGNERe
Designer accessV
ACLLEVEL_MANAGER
Manager access
Return value
lotus.notes.ACLEntry
The newly-created entry.
Usage
You must call Save on the ACL if you want the modified ACL to be saved to disk.
For more information, see the lotus.notes.ACLEntry class.
Click here to see this topic
See examples
See related topics
Click here to see this topic
lotus.notes.ACLEntry class
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Creates an empty copy of the current database. The copy contains the design elements of the current database, an identical access control list, and an identical title. The copy does not contain any documents and is not a replica.
Defined in
Click here to see this topic
lotus.notes.Database
Click here to see this topic
Syntax
public lotus.notes.Database createCopy(String server, String dbfile)
throws NotesException
Parameters
String server
The name of the server where the new database resides. Use an empty string ("") to create a copy on the current computer.
String dbfile
The file name of the new copy.
Return value
lotus.notes.Database
The new copy.
Usage
If a database with the specified file name already exists on the server, an exception is thrown.
Programs running on a server can't create or access databases on other servers. Therefore, if the program runs on a server, the
erver
parameter must correspond to the server the program is running on. There are two ways to do this:o
Use an empty string ("") to indicate the current computer. This is the safer method.
Make sure the name of the server that the program runs on matches the name of
erver
Programs running on a workstation can access several different servers in a single script.
The ACL of the original database gets copied to the new database, but you may want to modify the copy's ACL. For example, you may want Manager access to the copy for yourself even if you're not a manager of the original. Use the methods grantAccess and removeAccess to modify the copy's ACL.
Click here to see this topic
See examples
See related topics
Click here to see this topic
copyToDatabase method
Click here to see this topic
Click here to see this topic
createDatabase method
Click here to see this topic
Click here to see this topic
createFromTemplate method
Click here to see this topic
Click here to see this topic
createReplica method
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Creates a new lotus.notes.DateRange object._
Defined in
Click here to see this topic
lotus.notes.Session
Click here to see this topic
Syntax
public lotus.notes.DateRange createDateRange()
throws NotesException
public lotus.notes.DateRange createDateRange(lotus.notes.DateTime startt, lotus.notes.DateTime endt)
throws NotesException
Parameters
Click here to see this topic
lotus.notes.DateTime
Click here to see this topic
startt
The starting date-time of the range.
Click here to see this topic
lotus.notes.DateTime
Click here to see this topic
endte
The ending date-time of the range.
Return value
Click here to see this topic
lotus.notes.DateRangep
Click here to see this topic
The newly-created lotus.notes.DateRange object.
Usage
See the
Click here to see this topic
lotus.notes.DateRange
Click here to see this topic
class for descriptions and examples.c
See related topics
Click here to see this topic
Working with Notes time
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Given a string that represents the date and time you want, creates a new lotus.notes.DateTime object that represents that date and time.
Defined in
Click here to see this topic
lotus.notes.Sessioni
Click here to see this topic
Syntax
public lotus.notes.DateTime createDateTime(String date)
throws NotesException
Parameters
String dateC
The date and time you want the object to represent. If you use an empty string (""), the date is set to the default date of December 30, 1899. The Notes date-time expressions "Today" and "Yesterday" are supported.P
Return value
Click here to see this topic
lotus.notes.DateTime
Click here to see this topic
The newly-created date-time.
Usage_
See the
Click here to see this topic
lotus.notes.DateTime
Click here to see this topic
class for descriptions and examples.t
See related topics
Click here to see this topic
Working with Notes time
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Creates a document in a database and returns a lotus.notes.Document object that represents the new document. You must call Save if you want the new document to be saved to disk.
Defined in
Click here to see this topic
lotus.notes.Database
Click here to see this topic
Syntax
public lotus.notes.Document createDocument()
throws NotesException
Return value
lotus.notes.Document
The new document.V
Click here to see this topic
See examples
See related topics
Click here to see this topic
lotus.notes.Document class
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. The date a database was created.
Defined in
Click here to see this topic
lotus.notes.Database
Click here to see this topic
Data typeh
Click here to see this topic
lotus.notes.DateTime
Click here to see this topic
Syntax
public lotus.notes.DateTime getCreated()
throws NotesException
Click here to see this topic
See examples
See related topics
Click here to see this topic
LastModified property
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. The date a document was created.d
Defined in
Click here to see this topic
lotus.notes.Document
Click here to see this topic
Data type
Click here to see this topic
lotus.notes.DateTime
Click here to see this topic
Syntax
public lotus.notes.DateTime getCreated()
throws NotesException
Usage
This property is useful when you're writing a script to archive documents. You can compare the date that a document is created with a cutoff date. If the document is created before the date, you archive it.
Click here to see this topic
See examples
See related topics
Click here to see this topic
LastAccessed property
Click here to see this topic
Click here to see this topic
LastModified propertyh
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. The date that a view was created.
Defined in
Click here to see this topic
lotus.notes.View
Click here to see this topic
Data type
Click here to see this topic
lotus.notes.DateTime
Click here to see this topic
Syntax
public lotus.notes.DateTime getCreated()
throws NotesException
Click here to see this topic
See examples
See related topics
Click here to see this topic
LastModified property
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
If the current database is a template, creates a new database from the template. The new database has the design features and documents of the template.
Defined in
Click here to see this topic
lotus.notes.Database
Click here to see this topic
Syntax
public lotus.notes.Database createFromTemplate(String server, String dbfile, boolean inherit)
throws NotesException
Parameters
String server
The name of the server where the new database resides. Use an empty string ("") to create a database on the current computer.
String dbfile
The file name of the new database.
boolean inherit
Specify true if you want the new database to inherit future design changes from the template; otherwise, specify false.
Return value
lotus.notes.Database
The new database, which contains the forms, subforms, fields, views, folders, navigators, agents, and documents of the template.
Usage
If a database with the specified file name already exists on the server, an exception is thrown.
Programs running on a server can't create or access databases on other servers. Therefore, if the program runs on a server, the
server h
parameter must correspond to the server the program is running on. There are two ways to do this:
Use an empty string ("") to indicate the current computer. This is the safer method.
Make sure the name of the server that the program runs on matches the name of the
server
parameter.
Programs running on a workstation can access several different servers in a single program.
If the current database is not a template, the createFromTemplate method creates a new, blank database without any forms or views (equivalent to the create method).
Click here to see this topic
See examples
See related topics
Click here to see this topic
createCopy methodo
Click here to see this topic
Click here to see this topic
createDatabase method
Click here to see this topic
Click here to see this topic
createReplica method
Click here to see this topic
Click here to see this topic
DesignTemplateName property
Click here to see this topic
Click here to see this topic
TemplateName property
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Creates a new lotus.notes.Log object with the name you specify.
Defined in
Click here to see this topic
lotus.notes.SessionN
Click here to see this topic
Syntax
public lotus.notes.Log createLog(String name)
throws NotesException
Parametere
String name
A name that identifies the log.
Return value
Click here to see this topic
lotus.notes.Log
Click here to see this topic
The newly-created log.
Usaget
See the
Click here to see this topic
lotus.notes.Log
Click here to see this topic
class for descriptions and examples.
See related topics
Click here to see this topic
Making a Notes log
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-Write. Indicates whether a mail database is created with the ID file when calling _
Click here to see this topic
RegisterNewUserA
Click here to see this topic
Defined in
Click here to see this topic
lotus.notes.
Registration class
Click here to see this topic
Data type
boolean
Syntax
public boolean getCreateMailDb()
throws NotesException
public void setCreateMailDb(boolean flag)
throws NotesException
Legal values
True
A mail database is created.s
False
A mail database is not created. It will be created during setup.
Click here to see this topic
See examples
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Creates a new lotus.notes.Name object.
Defined in
Click here to see this topic
lotus.notes.Sessiond
Click here to see this topic
Syntax
public lotus.notes.Name createName(String name)
throws NotesExceptionr
Parameters
String namer
A user or server name. If the name is not in the format of an abbreviated or canonical hierarchical name, it is treated as a flat name.r
Return value
Click here to see this topic
lotus.notes.Name
Click here to see this topic
The new lotus.notes.Name object.
Usaget
See the
Click here to see this topic
lotus.notes.Name
Click here to see this topic
class for descriptions and examples.I
See related topics
Click here to see this topic
Representing a namet
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Given a lotus.notes.DocumentCollection containing the documents you want, creates a new lotus.notes.Newsletter.
Defined in
Click here to see this topic
lotus.notes.Sessiono
Click here to see this topic
Syntax
public lotus.notes.Newsletter createNewsletter(lotus.notes.DocumentCollection collection)
throws NotesException
Parameter
Click here to see this topic
lotus.notes.DocumentCollection
Click here to see this topic
collectiont
The documents that you want included in the newsletter.
Return value
Click here to see this topic
lotus.notes.Newsletter
Click here to see this topic
The newly-created newsletter.
Usage
See the
Click here to see this topic
lotus.notes.Newsletter
Click here to see this topic
for descriptions and examples.R
See related topics
Click here to see this topic
Making a Notes newsletterW
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-write. Indicates if an entry can create personal agents in a database.
Defined in
Click here to see this topic
lotus.notes.ACLEntry
Click here to see this topic
Data type
boolean
Syntax
public boolean isCanCreatePersonalAgent()
throws NotesException
public void setCanCreatePersonalAgent(boolean flag)
throws NotesException
Legal values
True
The entry can create personal agents in the database.
False
The entry cannot create personal agents.
Usagee
After setting this property, you must call Save on the parent lotus.notes.ACL in order for the changes to take effect. If you do not call Save, your changes to the lotus.notes.ACLEntry are lost.
If an entry has Designer access or above, setting this property to False has no effect.
Click here to see this topic
See examples
See related topics
Click here to see this topic
IsCanCreateDocuments property
Click here to see this topic
Click here to see this topic
IsCanCreatePersonalFolder property
Click here to see this topic
Click here to see this topic
IsCanDeleteDocuments property
Click here to see this topic
Click here to see this topic
save method
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-write. Indicates if an entry can create personal folders in a database.
Defined in
Click here to see this topic
lotus.notes.ACLEntry
Click here to see this topic
Data type
boolean
Syntax
public boolean isCanCreatePersonalFolder()
throws NotesException
public void setCanCreatePersonalFolder(boolean flag)
throws NotesException
Legal values
True
The entry can create personal folders in the database.
False
The entry cannot create personal folders.l
Usageh
After setting this property, you must call Save on the parent lotus.notes.ACL in order for the changes to take effect. If you do not call Save, your changes to the lotus.notes.ACLEntry are lost.
If an entry has Designer access or above, setting this property to False has no effect.
Click here to see this topic
See examples
See related topics
Click here to see this topic
IsCanCreateDocuments propertym
Click here to see this topic
Click here to see this topic
IsCanCreatePersonalAgent property
Click here to see this topic
Click here to see this topic
IsCanDeleteDocuments property
Click here to see this topic
Click here to see this topic
save methode
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Creates a new lotus.notes.Registration object.
Defined in
Click here to see this topic
lotus.notes.SessionE
Click here to see this topic
Syntax
public lotus.notes.Registration createRegistration()
throws NotesException
Return value
Click here to see this topic
lotus.notes.Registration
Click here to see this topic
The newly-created lotus.notes.Registration object.
Usage
See the
Click here to see this topic
lotus.notes.Registration class
Click here to see this topic
for descriptions and examples.s
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Creates a replica of the current database at a new location. The new replica has an identical access control list.
Defined in
Click here to see this topic
lotus.notes.Database
Click here to see this topic
Syntax
public lotus.notes.Database createReplica(String server, String dbfile)
throws NotesExceptionv
Parameters
String server
The name of the server where the replica will reside. Use an empty string ("") to create a replica on the current computer.
String dbfile
The file name of the replica.
Return value
lotus.notes.Database
The new replica.
Usage
If a database with the specified file name already exists on the server, an exception is thrown.
Programs running on a server can't create or access databases on other servers. Therefore, if the program runs on a server, the
erver
parameter must correspond to the server the program is running on. There are two ways to do this:
Use an empty string ("") to indicate the current computer. This is the safer method.
Make sure the name of the server that the program runs on matches the name of the
erver
parameter.
Programs running on a workstation can access several different servers in a single program.
Click here to see this topic
See examples
See related topics
Click here to see this topic
createCopy method
Click here to see this topic
Click here to see this topic
createDatabase method
Click here to see this topic
Click here to see this topic
createFromTemplate method
Click here to see this topic
Click here to see this topic
openDatabaseByReplicaID method
Click here to see this topic
Click here to see this topic
ReplicaID property
Click here to see this topic
Click here to see this topic
replicate method
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Creates a new document that is formatted as a reply to the current document.
Defined in
Click here to see this topic
lotus.notes.Document
Click here to see this topic
Syntax
public lotus.notes.Document createReplyMessage(boolean toall)
throws NotesException
Parametere
boolean toall
If true, the new document recipient list contains all the recipients of the original. If false, the new document recipient list contains only the sender of the original.
Return value
lotus.notes.Document
A reply to the current document.
Usagen
The new document does not contain a Subject item. If you want one, the script must explicitly add it to the document.
The new document does not get automatically mailed. If you want to mail it, the script must explicitly call the Send method.
Click here to see this topic
See examples
See related topics
Click here to see this topic
IsSentByAgent property
Click here to see this topic
Click here to see this topic
send method
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Creates a new rich text item in a document, using a name you specify, and returns the corresponding lotus.notes.RichTextItem object.
Defined in
Click here to see this topic
lotus.notes.Document
Click here to see this topic
Syntax
public lotus.notes.RichTextItem createRichTextItem(String name)
throws NotesExceptiona
ParameterA
String name
The name of the new rich text item.a
Return value
lotus.notes.RichTextItem
The newly-created item.
UsageU
For more information, see the lotus.notes.RichTextItem class.
Click here to see this topic
See examples
See related topics
Click here to see this topic
lotus.notes.RichTextItem class
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Creates a new lotus.notes.RichTextStyle object._
Defined in
Click here to see this topic
lotus.notes.SessionT
Click here to see this topic
Syntax
public lotus.notes.RichTextStyle createRichTextStyle()
throws NotesException
Return value
Click here to see this topic
lotus.notes.RichTextStyle
class
Click here to see this topic
The newly-created lotus.notes.RichTextStyle object.t
UsageE
See the
Click here to see this topic
lotus.notes.RichTextStyle class
Click here to see this topic
for descriptions and examples.P
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Creates a new database on disk, using the server and file name that you specify. Because the new database is not based on a template, it's blank and does not contain any forms or views.s
Defined in
Click here to see this topic
lotus.notes.DbDirectory
Click here to see this topic
Syntax
public lotus.notes.Database createDatabase(String dbfile)
throws NotesException
public lotus.notes.Database createDatabase(String dbfile, boolean open)
throws NotesExceptionB
Parameters
String dbfile
The file name of the new database.
boolean open
Indicates if you want to open the database. Specify true if you want to open the database and false if you do not. A database must be open to access its properties and methods. If you choose not to open the database when it's created, you can open it later with the openDatabase or openDatabaseIfModified method.
Click here to see this topic
See examples
See related topics
Click here to see this topic
createCopy method:
Click here to see this topic
Click here to see this topic
createFromTemplate method
Click here to see this topic
Click here to see this topic
createReplica method
Click here to see this topic
Click here to see this topic
openDatabase method
Click here to see this topic
Click here to see this topic
openDatabaseIfModified method
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Cross-certifies an ID file.
Defined in
Click here to see this topic
lotus.n
otes.Registration class
Click here to see this topic
Syntax
public boolean crossCertify(String idfile)
throws NotesException
public boolean crossCertify(String idfile, String certpw, String comment)
throws NotesExceptioni
Parameters
String idfileC
The ID file to be cross-certified. Specify the full path, for example, c:\notes\data\cert.id.
String certpws
The password for the certifier ID file.
String comment
The contents of the comment field in the Name and Address book record.
Return value
boolean
True if the operation is successful; false otherwise.
Click here to see this topic
See examples
See related topics
Click here to see this topic
addCertifierToAddressbook method
Click here to see this topic
Click here to see this topic
CertifierIDFile property
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. Indicates the number of decimal digits for number format.
Defined in
Click here to see this topic
lotus.notes.International Class
Click here to see this topic
Data type
Syntax
public int getCurrencyDigits()
throws NotesException
Click here to see this topic
See examples
Click here to see this topic
See related topics
Click here to see this topic
Accessing international settings
Click here to see this topic
Click here to see this topic
DecimalSep propertyi
Click here to see this topic
Click here to see this topic
IsCurrencyZero property
Click here to see this topic
Click here to see this topic
ThousandsSep property
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. The symbol that indicates a number is currency, for example, the dollar sign.
Examples\LotusScriptProgExamplesH_EXAMPLES_CURRENCYSYMBOL_PROPERTY_JAVAContext Help FormExamples: CurrencySymbol, IsCurrencySpace, and IsCurrencySuffix properties
Examples\LotusScriptProgExamplesH_EXAMPLES_DECIMALSEP_PROPERTY_JAVAContext Help FormExamples: DecimalSep, CurrencyDigits, isCurrencyZero, and ThousandsSep properties
Examples\LotusScriptProgExamplesH_EXAMPLES_FORMATMSGWITHDOCLINKS_METHOD_JAVAContext Help FormExamples: FormatMsgWithDoclinks method; IsDoScore, IsDoSubject, and SubjectItemName properties
Read-only. The current user's access level to a database.
Defined in
Click here to see this topic
lotus.notes.Database
Click here to see this topic
Data type
Syntax
public int getCurrentAccessLevel
throws NotesException
Legal values
ACLLEVEL_NOACCESS
No access
ACLLEVEL_DEPOSITOR
Depositor access
ACLLEVEL_READER
Reader accessP
ACLLEVEL_AUTHORg
Author access
ACLLEVEL_EDITORG
Editor access
ACLLEVEL_DESIGNER6
Designer access
ACLLEVEL_MANAGER
Manager access
Usage
If a program runs on a workstation, the CurrentAccessLevel is determined by the access level of the current user.
If a program runs on a server, the CurrentAccessLevel is determined by the access level of the person who last saved the script (the script owner).
Click here to see this topic
See examples
See related topics
Click here to see this topic
grantAccess method
Click here to see this topic
Click here to see this topic
lotus.notes.ACL class
Click here to see this topic
Click here to see this topic
lotus.notes.ACLEntry class
Click here to see this topic
Click here to see this topic
queryAccess method
Click here to see this topic
Click here to see this topic
revokeAccess methode
Click here to see this topic
Click here to see this topic
UserName propertyl
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. The agent that's currently running.
Defined in
Click here to see this topic
lotus.notes.Agentv
Context
Click here to see this topic
Data type
Click here to see this topic
lotus.notes.Agent
Click here to see this topic
Syntax
public lotus.notes.Agent getCurrentAgent()
throws NotesException
Click here to see this topic
See examples
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. The database in which the current agent resides.
Defined in
Click here to see this topic
lotus.notes.Agent
Context
Click here to see this topic
Data typew
Click here to see this topic
lotus.notes.Database
Click here to see this topic
Syntax
public lotus.notes.Database getCurrentDatabase()
throws NotesException
Usage
This property allows you to access a database without having to specify its server and file namet. Using getCurrentDatabase can make programs more portable from one database to another.t
Click here to see this topic
See examples
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. A string representation of the date part of the time-date.b
Defined in
Click here to see this topic
lotus.notes.DateTime
Click here to see this topic
Data typeN
String
Syntax
public String getDateOnly()
throws NotesException
Click here to see this topic
See examples
Click here to see this topic
See related topics
Click here to see this topic
convertToZone method
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. The character used to separate months, days, and years, for example, the slash.
Defined in
Click here to see this topic
lotus.notes.International ClassI
Click here to see this topic
Data type
Object of type java.lang.String
Syntax
public String getDateSep()
throws NotesException
Click here to see this topic
See examples
Click here to see this topic
See related topics
Click here to see this topic
Accessing international settings
Click here to see this topic
Click here to see this topic
IsDateDMY property
Click here to see this topic
Click here to see this topic
IsDateMDY property
Click here to see this topic
Click here to see this topic
IsDateYMD property
Click here to see this topic
Click here to see this topic
IsDST property
Click here to see this topic
Click here to see this topic
IsDST property
Click here to see this topic
Click here to see this topic
Today property
Click here to see this topic
Click here to see this topic
Tomorrow propertyF
Click here to see this topic
Click here to see this topic
Yesterday property
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-Write. For a date-time item, returns a lotus.notes.DateTime object representing the value of the item. For items of other types, returns null.c
Defined in
Click here to see this topic
lotus.notes.Item
Click here to see this topic
Data type
Click here to see this topic
lotus.notes.DateTime
Click here to see this topic
Syntax
public lotus.notes.DateTime getDateTimeValue()
throws NotesException
public void setDateTimeValue(lotus.notes.DateTime value)
throws NotesException
Usage
Unlike LotusScript date-time variants, Notes date-time items and lotus.notes.DateTime objects store a time zone and hundredths of a second. Use the DateTimeValue property if you need to retain an item's time zone or hundredths of a second component.t
Click here to see this topic
See examples
See related topics
Click here to see this topic
Type property
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. The decimal separator for number format, for example, the decimal point.C
Defined in
Click here to see this topic
lotus.notes.International Class
Click here to see this topic
Data type
Object of type java.lang.String
Syntax
public String getDecimalSep()
throws NotesExceptiona
Click here to see this topic
See examples
Click here to see this topic
See related topics
Click here to see this topic
Accessing international settings
Click here to see this topic
Click here to see this topic
CurrencyDigits property
Click here to see this topic
Click here to see this topic
IsCurrencyZero property
Click here to see this topic
Click here to see this topic
ThousandsSep property
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-write. Indicates whether updates to a server are delayed (batched) for better performance.=
Defined in
Click here to see this topic
lotus.notes.Database
Click here to see this topic
Data type
boolean
Syntax
public boolean isDelayUpdates()
throws NotesException
public void setDelayUpdates(boolean delay)
throws NotesException
Legal Values
True
Server updates are delayed.
Falsel
Server updates are posted immediately; this is the default.t
Usagen
If DelayUpdates is false, the script waits for updates to the server to be posted. If you set DelayUpdates to true, server updates are cached and the script proceeds immediately. At a convenient time, the cached updates are posted. This makes for better performance but risks losing the cached updates in the event of a crash. This method applies to Save and remove operations on documents.
Click here to see this topic
See examples
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Deletes an ID file from the server.
Defined in
Click here to see this topic
lotus.n
otes.Registration classh
Click here to see this topic
Syntax
public void deleteIDOnServer(String username, boolean isserverid)
throws NotesException
Parameters
String usernameo
The username attached to the ID file.
boolean isserverid
True if the name you query represents a server ID. False if the name is that of a person. While the information always comes from the designated server's address book, this argument helps you to choose a view to search.
Click here to see this topic
See examples
See related topics
Click here to see this topic
getIDFromServer method
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Deletes a role from an ACL.
Defined in
Click here to see this topic
lotus.notes.ACL
Click here to see this topic
Syntax
public void deleteRole(String name)
throws NotesExceptionA
Parameters
String name
The name of the role to remove.
Usage
If the role does not exist in the ACL, Notes throws the exception: "Role name not found."
Click here to see this topic
See examples
See related topics
Click here to see this topic
addRole method
Click here to see this topic
Click here to see this topic
disableRole method
Click here to see this topic
Click here to see this topic
enableRole methodg
Click here to see this topic
Click here to see this topic
isRoleEnabled method
Click here to see this topic
Click here to see this topic
Roles property
Click here to see this topic
Click here to see this topic
Roles property
Click here to see this topic
&6EJ6
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. The name of the design template from which a database inherits its design. If the database does not inherit its design from a design template, returns null.
Defined in
Click here to see this topic
lotus.notes.Database
Click here to see this topic
Data type
Object of type java.lang.Stringl
Syntax
public String getDesignTemplateName()
throws NotesExceptione
Usage
If a database inherits a specific design element (such as a form) but not its entire design from a template, this property returns null.
Click here to see this topic
See examples
See related topics
Click here to see this topic
createFromTemplate methodH
Click here to see this topic
Click here to see this topic
TemplateName propertyl
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Given a role, disables the role for an entry.
Defined in
Click here to see this topic
lotus.notes.ACLEntry
Click here to see this topic
Syntax
public void disableRole(String role)
Parameter
String role
The name of the role to disable.
Usage
If the role exists in the ACL, but is already disabled for the entry, this method does nothing.y
If the role does not exist in the ACL, Notes throws the exception: "Role name not found."
Click here to see this topic
See examples
See related topics
Click here to see this topic
deleteRole method
Click here to see this topic
Click here to see this topic
enableRole method
Click here to see this topic
Click here to see this topic
isRoleEnabled method
Click here to see this topic
Click here to see this topic
Roles property
Click here to see this topic
Click here to see this topic
Roles property
Click here to see this topic
Jz aos
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. The in-memory document when an agent starts.
Defined in
Click here to see this topic
lotus.notes.Agent
Context
Click here to see this topic
Data type
Click here to see this topic
lotus.notes.Document
Click here to see this topic
Syntax
public lotus.notes.Document getDocumentContext()
throws NotesException
Usage
Through the C or C++ API, an external program can create an in-memory document, then run an agent. The agent can use this property to access the in-memory document.
For an agent activated in a view through the UI, the in-memory document is the document highlighted in the view.
Click here to see this topic
See examples
Click here to see this topic
qKevs
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-Write. For a newsletter document created using the
Click here to see this topic
formatMsgWithDoclinks method
Click here to see this topic
, indicates if the newsletter includes each document's relevance score.
Defined in
Click here to see this topic
lotus.notes.Newsletter
Click here to see this topic
Data type
booleanl
Syntax
public boolean isDoScore()
throws NotesException
public void setDoScore(boolean flag)
throws NotesException
Legal values
true if the newsletter includes each document's relevance score; default
false if the newsletter does not include relevance scores
Usage
This property has no effec for a newsletter document created using the
Click here to see this topic
formatDocument methodo
Click here to see this topic
This property applies only to newsletters whose collections are sorted; for example, a collection produced by a call to the
Click here to see this topic
FTSearch method
in lotus.notes.Database. If a newsletter's collection is unsorted, this property has no effect.
Click here to see this topic
See examples
Click here to see this topic
See related topics
Click here to see this topic
FTSearch methods
Click here to see this topic
Click here to see this topic
FTSearchScore property
Click here to see this topic
Click here to see this topic
lotus.notes.DocumentCollection class
Click here to see this topic
Click here to see this topic
unprocessedFTSearch method
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-Write. For a newsletter document created using the
Click here to see this topic
ormatMsgWithDoclinks method
Click here to see this topic
, indicates if the newsletter includes a string describing the subject of each document.
Defined in
Click here to see this topic
lotus.notes.Newsletter
Click here to see this topic
Data type
boolean
Syntax
public boolean isDoSubject()
throws NotesException
public void setDoSubject(boolean flag)
throws NotesException
Legal values
true if the newsletter includes a subject line for each document
false if the newsletter does not include subject lines; default
Usagei
This property has no effect for a newsletter document created using the
Click here to see this topic
formatDocument methodS
Click here to see this topic
This property must be used in conjunction with the SubjectItemName property, which determines the item used as a subject line (for example, "Subject," "Topic," or "Description"). If you do not specify the SubjectItemName property, the DoSubject property has no effect.
You must set both SubjectItemName and DoSubject before calling FormatMsgWithDoclinks.
Click here to see this topic
See examples
Click here to see this topic
See related topics
Click here to see this topic
formatMsgWithDoclinks method
Click here to see this topic
Click here to see this topic
SubjectItemName property
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Given the name of a verb, executes the verb in an embedded object. g
Defined in
Click here to see this topic
lotus.notes.EmbeddedObject
Click here to see this topic
Syntax
public void doVerb(String verb)
throws NotesException
Parameter
String verb
String. The name of one of the object's verbs.
See related topics
Click here to see this topic
Verbs property
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. The user name that is in effect for the current agent.
For an agent running on a workstation, this is the name of the current user.
For an agent running on a server, this is the name of the agent's owner (the person who last saved the agent).
Defined in
Click here to see this topic
lotus.notes.AgentContext
Click here to see this topic
Data type
Click here to see this topic
lotus.notes.Name
Click here to see this topic
Syntax
public String getEffectiveUserName()
throws NotesException
Usage
In general, getEffectiveUserName and
Click here to see this topic
getUserName
Click here to see this topic
return the same value for a given program. The exceptions are agents that run on a server, where getEffectiveUserName is the name of the script's owner and getUserName is the name of the server on which the script is running.
If the user name is hierarchical, this property returns the fully distinguished name. To get only the common name, use r
Click here to see this topic
getCommonUserName
Click here to see this topic
. To get only the common name of the owner of an agent that runs on a server, use
Click here to see this topic
getCommonOwner
Click here to see this topic
Click here to see this topic
See examples
Click here to see this topic
See related topics
Click here to see this topic
UserName property
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-Write. Effects as listed below.
Defined in
Click here to see this topic
lotus.notes.
RichTextStyle
Click here to see this topic
Data typea
inte
Syntax
public int getEffects()
throws NotesException
public void setEffects(int value)
throws NotesException
Legal values
EFFECTS_EMBOSS
EFFECTS_EXTRUDE
EFFECTS_NONE
EFFECTS_SHADOW
EFFECTS_SUBSCRIPT
EFFECTS_SUPERSCRIPT
STYLE_NO_CHANGE to maintain the previous state
Click here to see this topic
See examples
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. The OLE/2 and OLE/1 embedded objects in a document.
Note
EmbeddedObjects is not supported under OS/2, under UNIX, and on the Macintosh.
Defined in
Click here to see this topic
lotus.notes.Document
Click here to see this topic
Data type
Object of type java.util.Vector whose elements are objects of type t
Click here to see this topic
lotus.notes.EmbeddedObject
Click here to see this topic
Syntax
public java.util.Vector getEmbeddedObjects()
throws NotesException
Usage
Unlike the EmbeddedObjects property in lotus.notes.RichTextItem, this property does
include file attachments or OLE/ 1 objects created in Notes Release 3.
This property
does
include OLE/2 and OLE/1 objects created in Notes Release 4. It also includes objects in the document that were originally embedded in the document's form. Such objects must have been activated, modified, and re-saved in order to be returned by this property (otherwise they remain a part of the form, not the document).g
Click here to see this topic
See examples
See related topics
Click here to see this topic
EmbeddedObjects property
Click here to see this topic
Click here to see this topic
embedObject method
Click here to see this topic
Click here to see this topic
getAttachment method
Click here to see this topic
Click here to see this topic
getEmbeddedObject method
Click here to see this topic
Click here to see this topic
HasEmbedded property
Click here to see this topic
Click here to see this topic
lotus.notes.EmbeddedObject class
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. All the embedded objects, object links, and file attachments contained in a rich text item.
Note
EmbeddedObjects is not supported under OS/2, under UNIX, and on the Macintosh.
Defined in
Click here to see this topic
lotus.notes.RichTextItem
Click here to see this topic
Data type
Object of type java.util.Vector whose elements are objects of type lotus.notes.EmbeddedObjectl
Syntax
public java.util.Vector getEmbeddedObjects()
throws NotesException
Usage
This property includes OLE/1 and OLE/2 embedded objects and object links as well as file attachments.
If you need access to OLE/2 embedded objects that exist on a document but are not part of a rich text item (for example, because the object was originally created on the document's form), use the EmbeddedObjects property in lotus.notes.Document.i
Click here to see this topic
See examples
See related topics
Click here to see this topic
EmbeddedObjects property
Click here to see this topic
Click here to see this topic
embedObject method
Click here to see this topic
Click here to see this topic
getAttachment method
Click here to see this topic
Click here to see this topic
getEmbeddedObject method
Click here to see this topic
Click here to see this topic
HasEmbedded property
Click here to see this topic
Click here to see this topic
lotus.notes.EmbeddedObject class
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Given the name of a file or an application, does one of the following:
Attaches the file you specify to a rich text item.
Embeds an object in a rich text item. The object is created using either the application or the file you specify.
Places an object link in a rich text item. The link is created using the file you specify.
Note
EmbedObject is not supported under OS/2, under UNIX, and on the Macintosh.
Defined in
Click here to see this topic
lotus.notes.RichTextItem
Click here to see this topic
Syntax
public lotus.notes.EmbeddedObject embedObject(int type, String class, String source, String name)
throws NotesExceptione
Parameters
int type
Indicates if you want to create an attachment, an embedded object, or a object link. May be any of the following:
EMBED_ATTACHMENT
EMBED_OBJECT
EMBED_OBJECTLINK
String class
If you are using EMBED_OBJECT and want to create an empty embedded object from an application, use this parameter to specify the name of the application (for example, "123Worksheet") and specify an empty string ("") for
source$.
Case sensitive.
If you are using EMBED_OBJECTLINK or EMBED_ATTACHMENT, specify an empty string ("").
String source
If you are using EMBED_OBJECT and want to create an embedded object from a file, use this parameter to specify the name of the file, and specify an empty string ("") for
class$.
If you are using EMBED_ATTACHMENT or
;EMBED_OBJECTLINK, use this parameter to specify the name of the file to attach or link.e
String name
String. Optional. Name by which you can reference the lotus.notes.EmbeddedObject later.
Return value
lotus.notes.EmbeddedObject
The newly attached file, embedded object, or linked object.O
Usage
Files can be attached on any Notes platform, but objects and links can only be created on platforms supporting OLE.
Files can be embedded as OLE/2 objects only on platforms supporting OLE, but they can be embedded as OLE/1 objects on any Notes platform (if the file is of a supported type, such as a Lotus
application data file).
See related topics
Click here to see this topic
EmbeddedObjects property
Click here to see this topic
Click here to see this topic
EmbeddedObjects property
Click here to see this topic
Click here to see this topic
getAttachment method
Click here to see this topic
Click here to see this topic
getEmbeddedObject method
Click here to see this topic
Click here to see this topic
HasEmbedded property
Click here to see this topic
Click here to see this topic
lotus.notes.EmbeddedObject class
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Given the name of a role, enables the role for an entry.
Defined in
Click here to see this topic
lotus.notes.ACLEntry
Click here to see this topic
Syntax
public void enableRole(String role)
throws NotesException
Parameter
String role
The name of the role to enable.
Usage
If the role exists in the ACL, and is already enabled for the entry, this method does nothing.
If the role does not exist in the ACL, Notes throws the exception: "Role name not found."
Click here to see this topic
See examples
See related topics
Click here to see this topic
addRole method
Click here to see this topic
Click here to see this topic
deleteRole method
Click here to see this topic
Click here to see this topic
disableRole method
Click here to see this topic
Click here to see this topic
isRoleEnabled method
Click here to see this topic
Click here to see this topic
Roles property
Click here to see this topic
Click here to see this topic
Roles property
Click here to see this topic
&6EJ6
Jz aos
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-Write. The key(s) used to encrypt a document. The Encrypt method uses these keys when it encrypts the document.
Defined in
Click here to see this topic
lotus.notes.Document
Click here to see this topic
Data type
Object of type java.util.Vector whose elements are of type java.lang.String
Syntax
public java.util.Vector getEncryptionKeys()
throws NotesException
public void setEncryptionKeys(java.util.Vector keys)
throws NotesException
Usagee
Each element in the EncryptionKeys array contains the name of an encryption key you want to use to encrypt the document. The document can be decrypted by any user who posesses one of the keys. If there are no encryption keys specified for a document, the document is encrypted with the current user's public key and can only be decrypted by that user.e
You must call the Encrypt and Save methods to actually encrypt the document in the database. Since encryption works differently when a document is mailed, the EncryptionKeys property has no effect when a document is encrypted when mailed.
The name of each encryption key on a document is stored in a text item called SecretEncryptionKeys. This property returns the contents of the item.
Click here to see this topic
See examples
See related topics
Click here to see this topic
encrypt method
Click here to see this topic
Click here to see this topic
IsEncrypted property
Click here to see this topic
Click here to see this topic
IsEncryptOnSend property
Click here to see this topic
Click here to see this topic
save method
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-Write. Indicates if a document is encrypted when mailed.n
Defined in
Click here to see this topic
lotus.notes.Document
Click here to see this topic
Data type
boolean
Syntax
public boolean isEncryptOnSend()
throws NotesException
public void setEncryptOnSend(boolean flag)
throws NotesException
Legal values
True
The document is encrypted when mailed.
False@
The document is not encrypted when mailed.
UsageF
To encrypt a document when mailed, this method looks for the public key of each recipient in the Public Address Book. If it cannot find a recipient's public key, the method sends an unencrypted copy of the document to that recipient. All other recipients receive an encrypted copy of the document.n
This property has no effect on whether a document is encrypted when saved to a database.
Click here to see this topic
See examples
See related topics
Click here to see this topic
encrypt method
Click here to see this topic
Click here to see this topic
EncryptionKeys property
Click here to see this topic
Click here to see this topic
IsEncrypted property
Click here to see this topic
Click here to see this topic
IsSaveMessageOnSend property
Click here to see this topic
Click here to see this topic
IsSignOnSend property
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Encrypts a document in a database.
Defined in
Click here to see this topic
lotus.notes.Document
Click here to see this topic
Syntax
public void encrypt()
throws NotesException
Usage
The encrypted document is not written to disk until you call the Save method. Only the items for which the IsEncrypted property is true are encrypted. Items for which the IsEncrypted property is false remain visible to any user, even if the user does not have the proper encryption key.
If the EncryptionKeys property is set with one or more named keys, those keys are used to encrypt the document. Any user who has one of the encryption keys can decrypt the document. If there are no encryption keys specified, the document is encrypted with the user's public key, in which case only the user who encrypted the document can decrypt it.
If the program is running on a server, it must have permission to use Encrypt.
Since mail encryption works differently, don't use this method if you want to mail an encrypted document. Instead, set the EncryptOnSend property to true, and use the Send method.
Click here to see this topic
See examples
See related topics
Click here to see this topic
EncryptionKeys property
Click here to see this topic
Click here to see this topic
IsEncrypted property
Click here to see this topic
Click here to see this topic
IsEncryptOnSend property
Click here to see this topic
Click here to see this topic
save methode
Click here to see this topic
Click here to see this topic
send method,
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-write. The ending date-time of a range.
Defined in
Click here to see this topic
lotus.notes.DateRange
Click here to see this topic
Data typeJ
Click here to see this topic
lotus.notes.DateTime
Click here to see this topic
Syntax
public lotus.notes.DateTime getEndDateTime()
throws NotesException
public void setEndDateTime(lotus.notes.DateTime t)
throws NotesException
Usage
Modifying the lotus.notes.DateTime object that EndDateTime is based on implicitly modifies EndDateTime.i
Click here to see this topic
See examples
Click here to see this topic
List of classes :x
Click here to see this topic
createDateRange method
Click here to see this topic
Click here to see this topic
freeTimeSearch method
Click here to see this topic
Click here to see this topic
StartDateTime property
Click here to see this topic
Click here to see this topic
Text property
Click here to see this topic
Click here to see this topic
Working with Notes time
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Evaluates a Notes formula.
Defined in
Click here to see this topic
lotus.notes.Session
Click here to see this topic
Syntax
public java.util.Vector evaluate(String formula)
throws NotesException
public java.util.Vector evaluate(String formula, Document doc)
throws NotesException
Parameters
String formula
The formula.
Document doc
The formula context.
Return value
java.util.Vector
The result of the evaluation. A scalar result is returned in firstElement.
Usage
If the formula contains the name of a field, you must use the 2-parameter method. The formula takes the field from the document specified as parameter 2.
@Functions that affect the user interface do not work in evaluate. These include: @Command, @DbManager, @DbName, @DbTitle, @DDEExecute, @DDEInitiate, @DDEPoke, @DDETerminate, @DialogBox, @PickList, @PostedCommand, @Prompt, and @ViewTitle.
You cannot change a document with evaluate; you can only get a result. To change a document, write the result to the document with a method such as Document.replaceItemValue.
Click here to see this topic
See examples
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
This example sends a memo to the managers of the current database containing the name and comment of each agent in the database.
System.out.println("Ten years ago: " + dt.getLocalTime());
}
catch (Exception e)
{
e.printStackTrace();
}
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
This example gets the context for the current agent, then gets the agent itself and prints the agent name and comment.
import lotus.notes.*;_
public class agentcontextagent extends AgentBase
public void NotesMain()
{
try
{
Session s = getSession();
AgentContext ac = s.getAgentContext();
Agent agent = ac.getCurrentAgent();
String name = agent.getName();
String comment = agent.getComment();
if (comment == null) comment = "No comment";
System.out.println
("Current Agent: \"" + name + "\"");
System.out.println
("Comment: \"" + comment + "\"");
}
catch (Exception e)
{
e.printStackTrace();
}
}
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
This agent displays international time settings: 24-hour or 12-hour; for 12-hour, the AM and PM strings; the hour-minute-second separator; and the time zone.)
import lotus.notes.*;)
public class amstringagent extends AgentBase
public void NotesMain()
{
try
{
Session s = getSession();
International inat = s.getInternational();
if (inat.isTime24Hour())
System.out.println("Time format is 24-hour");
else {
System.out.println("Time format is 12-hour");
System.out.println("AM notation is \"" +
inat.getAMString() + "\"");
System.out.println("PM notation is \"" +
inat.getPMString() + "\"");
}
System.out.println("Time separator is \"" +
inat.getTimeSep()+ "\"");
System.out.println("Time zone is " +
inat.getTimeZone());
}
catch (Exception e)
{
e.printStackTrace();
}
}
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
This agent opens and then closes a mail log. When the close method is called, the log is mailed.
import lotus.notes.*;
import java.util.Vector;
public class closeagent extends AgentBase
public void NotesMain()
try
{
Session s = getSession();
Log log = s.createLog("Log closing");
Vector v = new Vector();
v.addElement(s.getUserName());
log.openMailLog(v, "Here's your log");
// log some errors and actions
log.close(); //mail memo gets sent now
}
catch (Exception e)
{
e.printStackTrace();
}
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
This example prints the name and comment of the current agent.
import lotus.notes.*;t
public class commentagent extends AgentBase
public void NotesMain()
{
try
{
Session s = getSession();
AgentContext ac = s.getAgentContext();
Agent agent = ac.getCurrentAgent();
System.out.println
("Current Agent is " + agent.getName());
System.out.println
("Comment : " + agent.getComment());
}
catch (Exception e)
{
e.printStackTrace();
}
}
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
This example prints the common owner name of the current agent.
import lotus.notes.*;k
public class commonowneragent extends AgentBase
public void NotesMain()
{
try
{
Session s = getSession();
AgentContext ac = s.getAgentContext();
Agent agent = ac.getCurrentAgent();
System.out.println
("Current Agent is " + agent.getName());
System.out.println
("Commomowner : " + agent.getCommonOwner());
}
catch (Exception e)
{
e.printStackTrace();
}
}
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
The following agent prints the common user name.
import lotus.notes.*;i
public class commonusernameagent extends AgentBase
public void NotesMain()
{
try
{
Session s = getSession();
String u = s.getCommonUserName();
System.out.println("Common user name = " + u);
}
catch (Exception e)
{
e.printStackTrace();
}
}
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
The following examples demonstrate the minimal code needed for a Java program that uses the Notes classes. The examples instantiate a Session object and print the String output of its getPlatform method (Platform property).
1. This is a stand-alone program that extends the NotesThread class:
import lotus.notes.*;t
public class platform1 extends NotesThread
public static void main(String argv[])
{
platform1 t = new platform1();
t.start();
}I
public void runNotes()
{
try
{
Session s = Session.newInstance();
String p = s.getPlatform();
System.out.println("Platform = " + p);
}
catch (Exception e)
{
e.printStackTrace();
}
}
2. This is a stand-alone program that implements the Runnable interface:
import lotus.notes.*;o
public class platform2 implements Runnable
public static void main(String argv[])
{
platform2 t = new platform2();
NotesThread nt = new NotesThread((Runnable)t);
nt.start();
}
public void run()
{
try
{
Session s = Session.newInstance();
String p = s.getPlatform();
System.out.println("Platform = " + p);
}
catch (Exception e)
{
e.printStackTrace();
}
}
3. This is an agent program:
import lotus.notes.*;
public class platform3 extends AgentBase
public void NotesMain()
{
try
{
Session s = getSession();
String p = s.getPlatform();
System.out.println("Platform = " + p);
}
catch (Exception e)
{
e.printStackTrace();
}
}
4. This is an agent program with print output that can be seen by a browser:
import lotus.notes.*;
import java.io.PrintWriter;y
public class platform3 extends AgentBase
public void NotesMain()
{
try
{
Session s = getSession();
String p = s.getPlatform();
PrintWriter pw = getAgentOutput();
pw.println("Platform = " + p);
}
catch (Exception e)
{
e.printStackTrace();
}
}
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
This agent converts the current time to zone 15 time.o
import lotus.notes.*;a
public class convertozoneagent extends AgentBase
public void NotesMain()
try
{
Session s = getSession();
DateTime dt = s.createDateTime("");
dt.setNow();
System.out.println("Here and now: " + dt.getZoneTime());
dt.convertToZone(15, true);
System.out.println("Converted to zone 15: " + dt.getZoneTime());
}
catch (Exception e)
{
e.printStackTrace();
}
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
The following agent displays the currency international settings: the currency symbol; whether a space is between the currency symbol and the number; whether the currency symbol follows the number.
import lotus.notes.*;
public class currencysymbolagent extends AgentBase
public void NotesMain()
{
try
{
Session s = getSession();
International inat = s.getInternational();
System.out.println("Currency symbol is \"" +
inat.getCurrencySymbol() + "\"");
if (inat.isCurrencySpace())
System.out.println
("Space between currency symbol and number");
else
System.out.println
("No space between currency symbol and number");
if (inat.isCurrencySuffix())
System.out.println
("Currency symbol follows number");
else
System.out.println
("Currency symbol does not follow number");
}
catch (Exception e)
{
e.printStackTrace();
}
}
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
This example prints the name of the current agent.
import lotus.notes.*;
public class currentagentagent extends AgentBase
public void NotesMain()
{
try
{
Session s = getSession();
AgentContext ac = s.getAgentContext();
Agent agent = ac.getCurrentAgent();
String name = agent.getName();
System.out.println
("Current Agent is \"" + name + "\"");
}
catch (Exception e)
{
e.printStackTrace();
}
}
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
This example prints the title of the current database.
import lotus.notes.*;
public class currentdatabaseagent extends AgentBase
public void NotesMain()
{
try
{
Session s = getSession();
AgentContext ac = s.getAgentContext();
Database db = ac.getCurrentDatabase();
String title = db.getTitle();
System.out.println
("Current Database is \"" + title + "\"");
}
catch (Exception e)
{
e.printStackTrace();
}
}
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
This agent prints the creation date of the current database.
This agent displays the date international settings: whether the date format is DMY, MDY, or YMD; the month-day-year separator; the keywords for yesterday, today, and tomorrow.
import lotus.notes.*;
public class datesepagent extends AgentBase
public void NotesMain()
{
try
{
Session s = getSession();
boolean except = false;
International inat = s.getInternational();
if (inat.isDateDMY())
System.out.println
("Format of date is \"DMY\"");
if (inat.isDateMDY())
System.out.println
("Format of date is \"MDY\"");
if (inat.isDateYMD())
System.out.println
("Format of date is \"YMD\"");
System.out.println
("Date separator is \"" + inat.getDateSep() + "\"");
System.out.println
("Text of date keywords: " +
inat.getYesterday() + ", " +
inat.getToday() + ", " +
inat.getTomorrow());
}
catch (Exception e)
{
e.printStackTrace();
}
}
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
This agent displays the decimal international settings: the number of decimal (fraction) digits; the decimal separator (between the whole and fraction parts); the 1000s separator; and whether a zero precedes the decimal point if the number is a fraction (no whole part).
import lotus.notes.*;
public class decimalsepagent extends AgentBase
public void NotesMain()
{
try
{
Session s = getSession();
International inat = s.getInternational();
System.out.println
("Number of decimal digits: " + inat.getCurrencyDigits());
2. This agent applies the @Sum @function to the Amount field (which allows multiple values) in each document and prints the result.
import java.util.*;
import lotus.notes.*;c
public class evaluate3agent extends AgentBase
public void NotesMain()
{
try
{
Session s = getSession();
AgentContext ac = s.getAgentContext();
Database db = ac.getCurrentDatabase();
DocumentCollection dc = db.getAllDocuments();
Document doc;
System.out.println("Count = " + dc.getCount());
for (int j=0; j<dc.getCount(); j++) {
doc = dc.getNthDocument(j);
Vector v = s.evaluate("@Sum(Amount)", doc);
System.out.println(v.firstElement() + " " +
doc.getItemValue("Subject"));
}
}
catch (Exception e)
{
e.printStackTrace();
}
}
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
This agent makes a document collection of all the documents (up to 15) in the current database containing the word "arachnid," and makes a newsletter based on the document collection. The agent formats a newsletter document for each document in the collection and sends them to the current user.
import lotus.notes.*;n
public class formatdocagent extends AgentBase
public void NotesMain()
try
{
Session s = getSession();
AgentContext ac = s.getAgentContext();
Database db = ac.getCurrentDatabase();
db.updateFTIndex(true);
DocumentCollection dc = db.FTSearch
("arachnid", 15);
if (dc.getCount()>0)
{
Newsletter news = s.createNewsletter(dc);
Document doc;
for (int j=0; j<dc.getCount(); j++)
{
doc = news.formatDocument(db, j+1);
doc.appendItemValue("Form", "Memo");
doc.appendItemValue
("Subject", "The Arachnid Report " + (j+1));
doc.send(false, s.getUserName());
}
}
}
catch (Exception e)
{
e.printStackTrace();
}
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
This agent makes a document collection of all documents in the current database containing the word "archanid," then makes a newsletter based on this document collection. The agent formats a messge with links to the newsletter documents and mails it to the current user.
import lotus.notes.*;
public class formatmsgagent extends AgentBase
public void NotesMain()
try
{
Session s = getSession();
AgentContext ac = s.getAgentContext();
Database db = ac.getCurrentDatabase();
db.updateFTIndex(true);
DocumentCollection dc = db.FTSearch("arachnid", 0);
if (dc.getCount()>0)
{
Newsletter news = s.createNewsletter(dc);
news.setSubjectItemName("Subject");
news.setDoSubject(true);
news.setDoScore(true);
Document doc = news.formatMsgWithDoclinks(db);
doc.appendItemValue("Form", "Memo");
doc.appendItemValue("Subject", "The Arachnid Report");
doc.send (false, s.getUserName());
}
}
catch (Exception e)
{
e.printStackTrace();
}
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
1. This example gets the value of the $EnvLoc environment variable.a
2. This agent sets the local date and time, then prints the date and time in local time and GMT.
import lotus.notes.*;
public class localtimesetagent extends AgentBase
public void NotesMain()
try
{
Session s = getSession();
DateTime dt = s.createDateTime("");
dt.setLocalTime("12/12/97 04:30:00 PM");
System.out.println(dt.getLocalTime());
System.out.println(dt.getGMTTime());
}
catch (Exception e)
{
e.printStackTrace();
}
3. This agent is the same as above but passes the date and time as integer values to setLocalDate and setLocalTime rather than as a string to setLocalTime.
import lotus.notes.*;
public class localtimeset2agent extends AgentBase
public void NotesMain()
try
{
Session s = getSession();
DateTime dt = s.createDateTime("");
dt.setLocalDate(1997, 12, 12, true);
dt.setLocalTime(1, 30, 0, 0);
System.out.println(dt.getLocalTime());
System.out.println(dt.getGMTTime());
}
catch (Exception e)
{
e.printStackTrace();
}
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
This agent disables and enables the action logging.
import lotus.notes.*;
import java.util.Vector;
public class logactionsagent extends AgentBase
public void NotesMain()
try
{
Session s = getSession();
Log log = s.createLog("Turning actions on and off");
Vector v = new Vector();
v.addElement(s.getUserName());
log.openMailLog(v, "Here's your log");
log.setLogActions(false);
log.logAction("This action does not get logged.");
log.setLogActions(true);
log.logAction("This action does get logged.");
log.close();
}
catch (Exception e)
{
e.printStackTrace();
}
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
This agent logs actions to a mail memo. It performs a full text search on the current database, and logs one action for each document that matches the full text search query.g
Each time the logAction method is called, it adds a new line to the Body item of the mail memo. For example, if FTSearch returns a collection of three documents, the body of the mail memo looks like this:
10/25/97 12:26:37 PM Botany Agent starting
10/25/97 12:26:42 PM Document Petals placed in folder.
10/25/97 12:26:44 PM Document Stems placed in folder.
10/25/97 12:26:46 PM Document Leaves placed in folder.
import lotus.notes.*;
import java.util.Vector;
public class logactionagent extends AgentBase
public void NotesMain()
try
{
Session s = getSession();
Log log = s.createLog("Botany Agent");
Vector v = new Vector();
v.addElement(s.getUserName());
log.openMailLog(v, "Log for botany agent");
AgentContext ac = s.getAgentContext();
Database db = ac.getCurrentDatabase();
DocumentCollection dc = db.FTSearch("botany", 0);
Document doc;
for (int j=0; j<dc.getCount(); j++)
{
doc = dc.getNthDocument(j+1);
doc.putInFolder("Botanist's Delight");
log.logAction("Document " +
doc.getItemValue("Subject") +
" placed in folder.");
}
log.close();
}
catch (Exception e)
{
e.printStackTrace();
}
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
This agent disables and enables error logging.
import lotus.notes.*;
import java.util.Vector;
public class logerrorsagent extends AgentBase
public void NotesMain()
try
{
Session s = getSession();
Log log = s.createLog("Turning errors on and off");
Vector v = new Vector();
v.addElement(s.getUserName());
log.openMailLog(v, "Here's your log");
log.setLogErrors(false);
log.logError(0, "This error does not get logged.");
log.setLogErrors(true);
log.logError(0, "This error does get logged.");
log.close();
}
catch (Exception e)
{
e.printStackTrace();
}
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
This agent searches for "Rocks" in the documents in the current database and logs an error message to logerror.log in the current Notes directory if no occurrences are found.
import lotus.notes.*;O
public class logerroragent extends AgentBase
public void NotesMain()
try
{
Session s = getSession();
AgentContext ac = s.getAgentContext();
Database db = ac.getCurrentDatabase();
Log log = s.createLog("Geology Agent");
log.openFileLog("logerror.log");
DocumentCollection dc = db.FTSearch("Rocks", 0);
if (dc.getCount() == 0)
{
log.logError(0, "No documents found");
}
else
{
Newsletter news = s.createNewsletter(dc);
news.setSubjectItemName("Subject");
Document doc = news.formatMsgWithDoclinks(db);
doc.appendItemValue("Form", "Memo");
doc.appendItemValue("Subject", "The Rock Report");
doc.send (false, s.getUserName());
}
}
catch (Exception e)
{
e.printStackTrace();
}
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
This example opens a file log named agent4.log in the current Notes directory, and appends the message "Agent 4 invoked"."
import lotus.notes.*;
public class agent4agent extends AgentBase
public void NotesMain()
try
{
Session s = getSession();
Log log = s.createLog("Agent 4");
log.openFileLog("agent4.log");
log.logAction("Agent 4 invoked");
}
catch (Exception e)
{
e.printStackTrace();
}
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
1. This agent creates a newsletter consisting of links to all the documents in the current database that contain the word "arachnid" and mails the newsletter to the current user.
import lotus.notes.*;
public class newsletter1agent extends AgentBase
public void NotesMain()
try
{
Session s = getSession();
AgentContext ac = s.getAgentContext();
Database db = ac.getCurrentDatabase();
db.updateFTIndex(true);
DocumentCollection dc = db.FTSearch("arachnid", 15);
if (dc.getCount()>0)
{
Newsletter news = s.createNewsletter(dc);
news.setSubjectItemName("Subject");
news.setDoSubject(true);
Document doc = news.formatMsgWithDoclinks(db);
doc.appendItemValue("Form", "Memo");
doc.appendItemValue("Subject", "The Arachnid Report");
doc.send (false, s.getUserName());
}
}
catch (Exception e)
{
e.printStackTrace();
}
2. This agent creates a newsletter consisting of a picture of the document for each document in the current database that contains the word "arachnid." The documents are saved in Reports.nsf.
1. This example prints the name of the current agent.(
import lotus.notes.*;e
public class nameagent extends AgentBase
public void NotesMain()
{
try
{
Session s = getSession();
AgentContext ac = s.getAgentContext();
Agent agent = ac.getCurrentAgent();
System.out.println
("Current Agent is \"" + agent.getName()) + "\"";
}
catch (Exception e)
{
e.printStackTrace();
}
}
2. This example prints the names of all agents in the current databaset.
import lotus.notes.*;
import java.util.Vector;
public class allnamesagent extends AgentBase
public void NotesMain()
{
try
{
Session s = getSession();
AgentContext ac = s.getAgentContext();
Database db = ac.getCurrentDatabase();
Vector agents = db.getAgents();
System.out.println("Agents in database:");
for (int i = 0; i < agents.size(); i++)
{
Agent agent = (Agent) agents.elementAt(i);
System.out.println(" " + agent.getName());
}
}
catch (Exception e)
{
e.printStackTrace();
}
}
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
1. This example prints the name of the current agent.(
import lotus.notes.*;e
public class nameagent extends AgentBase
public void NotesMain()
{
try
{
Session s = getSession();
AgentContext ac = s.getAgentContext();
Agent agent = ac.getCurrentAgent();
System.out.println
("Current Agent is \"" + agent.getName()) + "\"";
}
catch (Exception e)
{
e.printStackTrace();
}
}
2. This example prints the names of all agents in the current databaset.
import lotus.notes.*;
import java.util.Vector;
public class allnamesagent extends AgentBase
public void NotesMain()
{
try
{
Session s = getSession();
AgentContext ac = s.getAgentContext();
Database db = ac.getCurrentDatabase();
Vector agents = db.getAgents();
System.out.println("Agents in database:");
for (int i = 0; i < agents.size(); i++)
{
Agent agent = (Agent) agents.elementAt(i);
System.out.println(" " + agent.getName());
}
}
catch (Exception e)
{
e.printStackTrace();
}
}
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
1. This example sets the StartDateTime and EndDateTime properties of a lotus.notes.DateRange object through the createDateRange parameters, then displays the value of the Text property.
import lotus.notes.*;#
public class daterange1agent extends AgentBase
public void NotesMain()
try
{
Session s = getSession();
AgentContext ac = s.getAgentContext();
Database db = ac.getCurrentDatabase();
DateTime dtdb = db.getCreated();
DateTime dtnow = s.createDateTime(null);
dtnow.setNow();
DateRange dr = s.createDateRange(dtdb, dtnow);
System.out.println
("Creation date - now:");
System.out.println
(" " + dr.getText());
}
catch (Exception e)
{
e.printStackTrace();
}
2. This example sets the StartDateTime and EndDateTime properties of a lotus.notes.DateRange object through the property methods, then displays the value of the Text property
import lotus.notes.*;
public class daterange2agent extends AgentBase
public void NotesMain()
try
{
Session s = getSession();
AgentContext ac = s.getAgentContext();
Database db = ac.getCurrentDatabase();
DateTime dtdb = db.getCreated();
DateTime dtnow = s.createDateTime(null);
dtnow.setNow();
DateRange dr = s.createDateRange();
dr.setStartDateTime(dtdb);
dr.setEndDateTime(dtnow);
System.out.println
("Creation date - now:");
System.out.println
(" " + dr.getText());
}
catch (Exception e)
{
e.printStackTrace();
}
3. This example writes a value to the Text property, then displays the LocalTime property of the StartDateTime and EndDateTime properties (which are lotus.notes.DateTime objects).
import lotus.notes.*;(
public class daterange3agent extends AgentBase
public void NotesMain()
try
{
Session s = getSession();
AgentContext ac = s.getAgentContext();
Database db = ac.getCurrentDatabase();
DateTime dtdb = db.getCreated();
DateTime dtnow = s.createDateTime(null);
dtnow.setNow();
DateRange dr = s.createDateRange();
dr.setText
(dtdb.getLocalTime() + " - " +
dtnow.getLocalTime());
dr.setStartDateTime(dtdb);
dr.setEndDateTime(dtnow);
System.out.println
("Creation date - now:");
System.out.println
(dr.getStartDateTime().getLocalTime()
+ " - " +
dr.getEndDateTime().getLocalTime());
}
catch (Exception e)
{
e.printStackTrace();
}
4. This example sets a value for a lotus.notes.DateRange object, then changes the lotus.notes.DateTime object that the EndDateTime property is based on. This implicitly changes the EndDateTime property.
import lotus.notes.*;
public class daterange4agent extends AgentBase
public void NotesMain()
try
{
Session s = getSession();
AgentContext ac = s.getAgentContext();
Database db = ac.getCurrentDatabase();
DateTime dtdb = db.getCreated();
DateTime dtplus = s.createDateTime(null);
dtplus.setNow();
DateRange dr = s.createDateRange(dtdb, dtplus);
dtplus.adjustMonth(2);
System.out.println
("Creation date - 2 months from now:");
System.out.println
(" " + dr.getText());
}
catch (Exception e)
{
e.printStackTrace();
}
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
1. This agent creates a new lotus.notes.DateTime object and prints it in local time and GMT. p
2. This agent checks the result of getLocalTime against null to determine that the format of a DateTime value is invalid.
import lotus.notes.*;+
public class datetime2agent extends AgentBase
public void NotesMain()
try
{
Session s = getSession();
DateTime dt = s.createDateTime
("bad12/12/96 04:30:00 PM");
if (dt.getLocalTime() == null) {
System.out.println("Bad format"); }
else {
System.out.println(dt.getLocalTime());
System.out.println(dt.getGMTTime()); }
}
catch (NotesException e)
{
e.printStackTrace();
}
3. This script creates a new lotus.notes.DateTime object that represents today's date and then prints it in local time. The time component of the lotus.notes.DateTime object is not set.s
import lotus.notes.*;t
public class datetime3agent extends AgentBase
public void NotesMain()
try
{
Session s = getSession();
DateTime dt = s.createDateTime("Today");
System.out.println(dt.getLocalTime());
}
catch (Exception e)
{
e.printStackTrace();
}
4. This script creates two new lotus.notes.DateTime objects. The first represents January 15, 1900; the second represents January 15, 2000.n
import lotus.notes.*;o
public class datetime6agent extends AgentBase
public void NotesMain()
try
{
Session s = getSession();
DateTime dt1 = s.createDateTime("01/15/1900");
DateTime dt2 = s.createDateTime("01/15/00");
System.out.println(dt1.getLocalTime());
System.out.println(dt2.getLocalTime());
}
catch (Exception e)
{
e.printStackTrace();
}
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
This agent examines three international settings and displays a setting's value if it deviates from what the agent considers standard.
import lotus.notes.*;n
public class internationalagent extends AgentBase
public void NotesMain()
{
try
{
Session s = getSession();
boolean except = false;
International inat = s.getInternational();
if (!inat.getCurrencySymbol().equals("$")) {
System.out.println("Currency symbol is " +
inat.getCurrencySymbol());
except = true;
}
if (!inat.getDecimalSep().equals(".")) {
System.out.println("Decimal separator is " +
inat.getDecimalSep());
except = true;
}
if (inat.isTime24Hour()) {
System.out.println("Time is 24-hour");
except = true;
}
if (!except) {
System.out.println("No exceptions");
}
}
catch (Exception e)
{
e.printStackTrace();
}
}
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
1. This agent opens a mail log and sends it to the current user when the log closes.
import lotus.notes.*;
import java.util.Vector;
public class log1agent extends AgentBase
public void NotesMain()
try
{
Session s = getSession();
Log log = s.createLog("Checkup Agent");
Vector v = new Vector();
v.addElement(s.getUserName());
log.openMailLog(v, "Log for checkup agent");
log.close();
}
catch (Exception e)
{
e.printStackTrace();
}
2. This agent opens a mail log, logs an action for each document in the current database, and sends the log to the current user when the log closes.
import lotus.notes.*;
import java.util.Vector;
public class log2agent extends AgentBase
public void NotesMain()
try
{
Session s = getSession();
AgentContext ac = s.getAgentContext();
Log log = s.createLog("Cleansing Agent");
Vector v = new Vector();
v.addElement(s.getUserName());
log.openMailLog(v, "Log for cleansing agent");
Database db = ac.getCurrentDatabase();
DocumentCollection dc = db.getAllDocuments();
for (int j=0; j<dc.getCount(); j++)
{
log.logAction("Processed document " + (j+1));
}
log.close();
}
catch (Exception e)
{
e.printStackTrace();
}
3. This example opens a Notes log and logs an error. The database agentlog.nsf must be based on the StdR4AgentLog template.s
import lotus.notes.*;
import java.util.Vector;
public class log3agent extends AgentBase
public void NotesMain()
try
{
String viewName = "Bad view";
Session s = getSession();
AgentContext ac = s.getAgentContext();
Agent agent = ac.getCurrentAgent();
Database db = ac.getCurrentDatabase();
Log log = s.createLog(
agent.getName() + " Agent in " +
db.getTitle() + " on " + db.getServer());
log.openNotesLog(null, "agentlog.nsf");
View view = db.getView(viewName);
if (view == null)
{
log.logError(0, "Unable to find view " +
viewName);
}
log.close();
}
catch (Exception e)
{
e.printStackTrace();
}
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
This example displays properties of lotus.notes.Name that are not null.
import lotus.notes.*;
class name extends NotesThread
public static void main(String argv[])
{
name t = new name();
t.start();
}
public void runNotes()
{
try
{
Session s = Session.newInstance();
Name n = s.createName(s.getUserName());
if (n.isHierarchical())
{
System.out.println
("Canonical name = " + n.getCanonical());
System.out.println
("Abbreviated name = " + n.getAbbreviated());
}
System.out.println
("Common name = " + n.getCommon());
if (n.getOrganization() != null)
System.out.println
("Organization = " + n.getOrganization());
if (n.getOrgUnit1() != null)
System.out.println
("OrgUnit1 = " + n.getOrgUnit1());
if (n.getOrgUnit2() != null)
System.out.println
("OrgUnit2 = " + n.getOrgUnit2());
if (n.getOrgUnit3() != null)
System.out.println
("OrgUnit3 = " + n.getOrgUnit3());
if (n.getOrgUnit4() != null)
System.out.println
("OrgUnit4 = " + n.getOrgUnit4());
if (n.getGiven() != null)
System.out.println
("Given = " + n.getGiven());
if (n.getSurname() != null)
System.out.println
("Surname = " + n.getSurname());
if (n.getInitials() != null)
System.out.println
("Initials = " + n.getInitials());
if (n.getGeneration() != null)
System.out.println
("Generation = " + n.getGeneration());
if (n.getADMD() != null)
System.out.println
("ADMD = " + n.getADMD());
if (n.getPRMD() != null)
System.out.println
("PRMD = " + n.getPRMD());
if (n.getKeyword() != null)
System.out.println
("Keyword = " + n.getKeyword());
}
catch (Exception e)
{
e.printStackTrace();
}
}
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
1. This agent performs a full text search on the current database and creates a newsletter. The agent formats a newsletter message containing a link to each matching document and sends it to the current user.
import lotus.notes.*;
public class newsletter1agent extends AgentBase
public void NotesMain()
try
{
Session s = getSession();
AgentContext ac = s.getAgentContext();
Database db = ac.getCurrentDatabase();
db.updateFTIndex(true);
DocumentCollection dc = db.FTSearch("arachnid", 15);
if (dc.getCount()>0)
{
Newsletter news = s.createNewsletter(dc);
news.setSubjectItemName("Subject");
news.setDoSubject(true);
Document doc = news.formatMsgWithDoclinks(db);
doc.appendItemValue("Form", "Memo");
doc.appendItemValue("Subject", "The Arachnid Report");
doc.send (false, s.getUserName());
}
}
catch (Exception e)
{
e.printStackTrace();
}
2. This agent performs a full text search on the current database and creates a newsletter. The agent formats a newsletter document for each matching document and saves it in the database Reports.nsf.
This program displays the version number of Notes installed in the local Notes directory.
import lotus.notes.*;
public class versionagent extends AgentBase
public void NotesMain()
{
try
{
Session s = getSession();
String v = s.getNotesVersion();
System.out.println("Notes version = " + v);
}
catch (Exception e)
{
e.printStackTrace();
}
}
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
This agent prints the number of each action in the action message.
import lotus.notes.*;
import java.util.Vector;
public class numactionsagent extends AgentBase
public void NotesMain()
try
{
Session s = getSession();
Log log = s.createLog("Counting actions");
Vector v = new Vector();
v.addElement(s.getUserName());
log.openMailLog(v, "Here's your log");
log.logAction("Action number " +
log.getNumActions());
log.logAction("Action number " +
log.getNumActions());
log.logAction("Action number " +
log.getNumActions());
log.close();
}
catch (Exception e)
{
e.printStackTrace();
}
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
This agent prints the number of the error number in the log message.
import lotus.notes.*;
import java.util.Vector;
public class numerrorsagent extends AgentBase
public void NotesMain()
try
{
Session s = getSession();
Log log = s.createLog("Counting agents");
Vector v = new Vector();
v.addElement(s.getUserName());
log.openMailLog(v, "Here's your log");
log.logError(0, "Error number " +
(log.getNumErrors()+1));
log.logError(0, "Error number " +
(log.getNumErrors()+1));
log.logError(0, "Error number " +
(log.getNumErrors()+1));
log.close();
}
catch (Exception e)
{
e.printStackTrace();
}
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
This agent opens the agent log and writes an action message to it.
import lotus.notes.*;
import java.util.Vector;
public class openagentlogagent extends AgentBase
public void NotesMain()
try
{
Session s = getSession();
Log log = s.createLog("Agent Log");
log.openAgentLog();
log.logAction("Action one");
log.close();
}
catch (Exception e)
{
e.printStackTrace();
}
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
1. This agent opens a file called append.TXT in the Notes directory. Each action and error gets appended to the file on a separate line without writing over the existing contents of the file.a
import lotus.notes.*;s
public class openfilelog1agent extends AgentBase
public void NotesMain()
try
{
Session s = getSession();
Log log = s.createLog("Append to file");
log.openFileLog("append.log");
log.logAction("Logged an action");
}
catch (Exception e)
{
e.printStackTrace();
}
2. This agent opens a file called over.TXT in the Notes directory. Each action and error gets appended to the file on a separate line after first writing over the existing contents of the file.
import lotus.notes.*;
public class openfilelog2agent extends AgentBase
public void NotesMain()
try
{
Session s = getSession();
Log log = s.createLog("Overwrite file");
log.setOverwriteFile(true);
log.openFileLog("over.log");
log.logAction("Logged an action");
}
catch (Exception e)
{
e.printStackTrace();
}
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
This agent script opens up a mail log. When the close method is called, the mail memo is sent to the owner of the agent with the name of the agent and the title of the database in the Subject.
import lotus.notes.*;
import java.util.Vector;
public class openmaillogagent extends AgentBase
public void NotesMain()
try
{
Session s = getSession();
AgentContext ac = s.getAgentContext();
Agent agent = ac.getCurrentAgent();
Database db = ac.getCurrentDatabase();
Log log = s.createLog(agent.getName());
Vector v = new Vector();
v.addElement(agent.getOwner());
log.openMailLog(v, agent.getName() +
" in " + db.getTitle());
log.close();
}
catch (Exception e)
{
e.printStackTrace();
}
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
1. This script opens AGENTLOG.NSF on the current computer. Each time an action or error is logged, a new document gets created in AGENTLOG.NSF.
import lotus.notes.*;
import java.util.Vector;
public class opennoteslogagent extends AgentBase
public void NotesMain()
try
{
Session s = getSession();
AgentContext ac = s.getAgentContext();
Log log = s.createLog("Database log");
log.openNotesLog(null, "agentlog.nsf");
log.logAction("Logging an action");
log.close();
}
catch (Exception e)
{
e.printStackTrace();
}
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
This program opens the default Web navigator database.
import lotus.notes.*;T
class geturldb extends NotesThread
public static void main(String argv[])
{
geturldb t = new geturldb();
t.start();
}
public void runNotes()
{
try
{
Session s = Session.newInstance();
Database db = s.getURLDatabase();
System.out.println
("Title of URL database: \"" + db.getTitle() + "\"");
}
catch (Exception e)
{
e.printStackTrace();
}
}
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
1. This script opens the over.txt file for logging. The existing contents of the file are removed before any actions or errors are logged.
import lotus.notes.*;
public class overwritefileagent extends AgentBase
public void NotesMain()
try
{
Session s = getSession();
Log log = s.createLog("Overwrite file");
log.setOverwriteFile(true);
log.openFileLog("over.log");
log.logAction("Logged an action");
}
catch (Exception e)
{
e.printStackTrace();
}
2. This agent script sets the IsOverwriteFile property to true if the agent last ran over seven days ago. If the agent last ran within the last seven days, it sets the IsOverwriteFile property to false.
import lotus.notes.*;
public class overwritefile2agent extends AgentBase
public void NotesMain()
try
{
Session s = getSession();
AgentContext ac = s.getAgentContext();
Log log = s.createLog("Overwrite file");
DateTime lastRun = ac.getLastRun();
DateTime nowDateTime = s.createDateTime("");
nowDateTime.setNow();
int daysSinceRun =
nowDateTime.timeDifference(lastRun) / 86400;
if (daysSinceRun > 7)
log.setOverwriteFile(true);
else
log.setOverwriteFile(false);
log.openFileLog("over.log");
log.logAction("Logged an action");
}
catch (Exception e)
{
e.printStackTrace();
}
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
This example prints the name and common owner of all the agents in the current database.
import lotus.notes.*;
import java.util.Vector;
public class owneragent extends AgentBase
public void NotesMain()
{
try
{
Session s = getSession();
AgentContext ac = s.getAgentContext();
Database db = ac.getCurrentDatabase();
Vector agents = db.getAgents();
for (int i = 0; i < agents.size(); i++)
{
Agent agent = (Agent) agents.elementAt(i);
System.out.println("Agent " + agent.getName() +
"'s owner is " + agent.getOwner());
}
}
catch (Exception e)
{
e.printStackTrace();
}
}
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
This example prints the name of the database on which the agent is running.
import lotus.notes.*;
public class parentagent extends AgentBase
public void NotesMain()
{
try
{
Session s = getSession();
AgentContext ac = s.getAgentContext();
Agent agent = ac.getCurrentAgent();
Database db = agent.getParent();
System.out.println
("Database on which this agent is running is '" +
db.getTitle() + "'");
}
catch (Exception e)
{
e.printStackTrace();
}
}
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
This program prints the name of the platform.=
import lotus.notes.*;o
class platform extends NotesThread
public static void main(String argv[])
{
platform t = new platform();
t.start();
}
public void runNotes()
{
try
{
Session s = Session.newInstance();
String p = s.getPlatform();
System.out.println("Platform = " + p);
}
catch (Exception e)
{
e.printStackTrace();
}
}
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
This agent prints the program name.
import lotus.notes.*;
public class programnameagent extends AgentBase
public void NotesMain()
try
{
Session s = getSession();
Log log = s.createLog("Program name file");
log.openFileLog("progname.log");
System.out.println
("Program name = \"" + log.getProgramName() + "\"");
}
catch (Exception e)
{
e.printStackTrace();
}
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
This script prints the name and query of every agent in the current database.
import lotus.notes.*;
import java.util.Vector;
public class queryagent extends AgentBase
public void NotesMain()
{
try
{
Session s = getSession();
AgentContext ac = s.getAgentContext();
Database db = ac.getCurrentDatabase();
Vector agents = db.getAgents();
System.out.println("Agents Query:");
for (int i = 0; i < agents.size(); i++)
{
Agent agent = (Agent) agents.elementAt(i);
String aq = agent.getQuery();
if (aq == null)
aq = "None";
System.out.println(agent.getName() + " - " + aq);
}
}
catch (Exception e)
{
e.printStackTrace();
}
}
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
This script removes the agent in the current database named "Agent To Delete."
import lotus.notes.*;
import java.util.Vector;
public class removeagent extends AgentBase
public void NotesMain()
{
try
{
Session s = getSession();
AgentContext ac = s.getAgentContext();
Database db = ac.getCurrentDatabase();
Vector agents = db.getAgents();
int count = agents.size(), i;
for (i = 0; i < count; i++)
{
Agent agent = (Agent) agents.elementAt(i);
String name = agent.getName();
if (name.compareTo("Agent To Delete") == 0)
{
agent.remove();
System.out.println("agent found and deleted");
break;
}
}
if (i == count)
System.out.println("agent not found");
}
catch (Exception e)
{
e.printStackTrace();
}
}
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
This script removes the agent in the current database named "Agent To Run."t
import lotus.notes.*;
import java.util.Vector;
public class runagent extends AgentBase
public void NotesMain()
{
try
{
Session s = getSession();
AgentContext ac = s.getAgentContext();
Database db = ac.getCurrentDatabase();
Vector agents = db.getAgents();
int count = agents.size(), i;
for (i = 0; i < count; i++)
{
Agent agent = (Agent) agents.elementAt(i);
String name = agent.getName();
if (name.compareTo("Agent To Run") == 0)
{
agent.run();
System.out.println("agent has been run");
break;
}
}
if (i == count)
System.out.println("agent not found");
}
catch (Exception e)
{
e.printStackTrace();
}
}
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
This example uses the save data record to find the maximum weekly sales.The data records have Weeky_Sales and Name fields. The saved data record has MaxSales and MaxSales_Salesperson fields. The data record fields replace the agent record fields whenever Weekly_Sales is greater than MaxSales.
If this agent runs on selected documents, getUnprocessedDocuments returns the selected documents.
import java.util.*;
import lotus.notes.*;
public class unprocesseddocumentsagent extends AgentBase
public void NotesMain()
{
try
{
Session s = getSession();
AgentContext ac = s.getAgentContext();
DocumentCollection dc = ac.getUnprocessedDocuments();
Document doc;
int size = dc.getCount();
System.out.println("Count = " + size);
for (int i = 1; i <= size; i++)
{
doc = dc.getNthDocument(i);
System.out.println
(i + " *** " + doc.getItemValue("Subject"));
}
}
catch (Exception e)
{
e.printStackTrace();
}
}
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
This agent runs on all or selected documents. It puts all documents that contain the word "botany" in the folder "Botanist's Delight."
import java.util.*;
import lotus.notes.*;=
public class unprocessedftsearchagent extends AgentBase
public void NotesMain()
{
try
{
Session s = getSession();
AgentContext ac = s.getAgentContext();
DocumentCollection dc = ac.unprocessedFTSearch
("botany", 0, Database.FT_SCORES,
Database.FT_STEMS+Database.FT_THESAURUS);
Document doc;
int size = dc.getCount();
System.out.println("Count = " + size);
for (int i = 1; i <= size; i++)
{
doc = dc.getNthDocument(i);
doc.putInFolder("Botanist's Delight");
System.out.println
(i + " *** " + doc.getItemValue("Subject"));
}
}
catch (Exception e)
{
e.printStackTrace();
}
}
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
This example searches all or selected documents for documents created after January 1, 1997 that contain "botany" in the Subject field, and places them in the "Botanist's Delight" folder.
import java.util.*;
import lotus.notes.*;s
public class unprocessedsearchagent extends AgentBase
public void NotesMain()
{
try
{
Session s = getSession();
AgentContext ac = s.getAgentContext();
DateTime date = s.createDateTime("01/01/97");
DocumentCollection dc = ac.unprocessedSearch
("@Contains(Subject; \"botany\")", date, 0);
Document doc;
int size = dc.getCount();
for (int i = 1; i <= size; i++)
{
doc = dc.getNthDocument(i);
doc.putInFolder("Botanist's Delight");
ac.updateProcessedDoc(doc);
System.out.println
(i + " *** " + doc.getItemValue("Subject"));
}
}
catch (Exception e)
{
e.printStackTrace();
}
}
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
This example is for an agent that runs on newly created and modified documents since the last run. The program gets the unprocessed documents, prints each Subject item, and marks each document as processed. The first time the agent runs, getUnprocessedDocuments returns all of the documents in the database. Thereafter, getUnprocessedDocuments returns those documents that updateProcessedDoc has not touched.
import java.util.*;
import lotus.notes.*;
public class updateprocesseddocagent extends AgentBase
public void NotesMain()
{
try
{
Session s = getSession();
AgentContext ac = s.getAgentContext();
DocumentCollection dc = ac.getUnprocessedDocuments();
Document doc;
int size = dc.getCount();
System.out.println("Count = " + size);
for (int i = 1; i <= size; i++)
{
doc = dc.getNthDocument(i);
System.out.println
(i + " *** " + doc.getItemValue("Subject"));
ac.updateProcessedDoc(doc);
}
}
catch (Exception e)
{
e.printStackTrace();
}
}
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
This agent gets a Name object for the current user and prints the common user name.
import lotus.notes.*;
public class usernameobjectagent extends AgentBase
public void NotesMain()
{
try
{
Session s = getSession();
Name no = s.getUserNameObject();
String u = no.getCommon();
System.out.println("Common user name = " + u);
}
catch (Exception e)
{
e.printStackTrace();
}
}
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
The following agent prints the user name.
import lotus.notes.*;
public class usernameagent extends AgentBase
public void NotesMain()
{
try
{
Session s = getSession();
String u = s.getUserName();
System.out.println("User name = " + u);
}
catch (Exception e)
{
e.printStackTrace();
}
}
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
1. This example increments the environment variable $SeqNo by one and prints the result. (This script would not be reliable on a server for maintaining a system of sequential numbers.)
2. This agent example prints the value of a system environment variable. The second argument to getEnvironmentString is true so that a dollar sign is not prepended to the name of the environment variable.
import lotus.notes.*;
class getenvironmentstring extends NotesThread
public static void main(String argv[])
{
getenvironmentstring t = new getenvironmentstring();
t.start();
}
public void runNotes()
{
try
{
Session s = Session.newInstance();
Database db;
String ms = s.getEnvironmentString("MailServer", true);
db = s.getDatabase(ms, "names.nsf");
System.out.println
("Title of names.nsf: \"" + db.getTitle() + "\"");
}
catch (Exception e)
{
e.printStackTrace();
}
}
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
1. This agent gets the creation date of the current database into a DateTime object, prints the date-time in local time and GMT time, converts the time to zone 15 time, and prints the zone 15 time.e
import lotus.notes.*;o
public class working1agent extends AgentBase
public void NotesMain()
try
{
Session s = getSession();
AgentContext ac = s.getAgentContext();
Database db = ac.getCurrentDatabase();
DateTime dt = db.getCreated();
System.out.println
("Creation date of current database");
System.out.println
(" Local time: " + dt.getLocalTime());
System.out.println
(" GMT time: " + dt.getGMTTime());
boolean dst = dt.isDST();
dt.convertToZone(15, dst);
System.out.println
(" Time in zone 15: " + dt.getZoneTime());
}
catch (Exception e)
{
e.printStackTrace();
}
2. This agent determines the earliest and latest creation dates for all the documents in the current database, and creates a DateRange object using these dates.
import lotus.notes.*;d
public class working2agent extends AgentBase
public void NotesMain()
try
{
Session s = getSession();
AgentContext ac = s.getAgentContext();
Database db = ac.getCurrentDatabase();
DocumentCollection dc = db.getAllDocuments();
Document doc = dc.getFirstDocument();
if (doc == null)
System.out.println("No documents");
else
{
DateTime dt1 = doc.getCreated();
DateTime dt2 = doc.getCreated();
doc = dc.getNextDocument(doc);
while(doc != null)
{
//if dt1 > Created, Created -> dt1
if(dt1.timeDifference(doc.getCreated())>0)
dt1 = doc.getCreated();
//if dt2 < Created, Created -> dt2
if(dt2.timeDifference(doc.getCreated())<0)
dt2 = doc.getCreated();
doc = dc.getNextDocument(doc);
}
DateRange dr = s.createDateRange(dt1, dt2);
System.out.println("Date range of documents:");
System.out.println(dr.getText());
}
}
catch (Exception e)
{
e.printStackTrace();
}
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-Write. The expiration date to use when creating ID files.
Defined in
Click here to see this topic
lotus.notes.
Registration class
Click here to see this topic
Data type
Click here to see this topic
lotus.notes.DateTime
Click here to see this topic
Syntax
public lotus.notes.DateTime getExpiration()
throws NotesException
public void setExpiration(lotus.notes.DateTime date)
throws NotesException
Click here to see this topic
See examples
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Copies a file attachment to disk.
Defined in
Click here to see this topic
lotus.notes.EmbeddedObject
Click here to see this topic
Syntax
public void extractFile(String path)
throws NotesException
Parameter
String path
The path and file name where you want to store the extracted file on disk.
Usage
For embedded objects and object links, this method raises an error.
Click here to see this topic
See examples
See related topics
Click here to see this topic
FileSize property
Click here to see this topic
Click here to see this topic
getAttachment method
Click here to see this topic
Click here to see this topic
remove method
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. The names of all the fields of a form.
Defined in
Click here to see this topic
lotus.notes.Form
Click here to see this topic
Data type
Object of type java.util.Vector whose elements are of type java.lang.Stringh
Syntax
public java.util.Vector getFields()
throws NotesExceptionL
Click here to see this topic
See examples
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. The file name of a database, excluding the path and .nsf extension.
Defined in
Click here to see this topic
lotus.notes.Database
Click here to see this topic
Data type
Object of type java.lang.String
Syntax
public String getFileName()
throws NotesException
Click here to see this topic
See examples
See related topics
Click here to see this topic
FilePath propertya
Click here to see this topic
Click here to see this topic
Server property
Click here to see this topic
Click here to see this topic
Title property
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. The path and file name of a database. The file name includes the .nsf extension.
Defined in
Click here to see this topic
lotus.notes.Database
Click here to see this topic
Data type
Object of type java.lang.Stringt
Syntax
public String getFilePath()
throws NotesException
Click here to see this topic
See examples
See related topics
Click here to see this topic
FileName property
Click here to see this topic
Click here to see this topic
Server property
Click here to see this topic
Click here to see this topic
Title property
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. The size of an embedded object, object link, or file attachment, in bytes.
Defined in
Click here to see this topic
lotus.notes.EmbeddedObject
Click here to see this topic
Data type
Syntax
public int getFileSize()
throws NotesException
Click here to see this topic
See examples
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-Write. Font size in points.
Defined in
Click here to see this topic
lotus.notes.
RichTextStyle
Click here to see this topic
Data typeA
Syntax
public int getFontSize()
throws NotesException
public void setFontSize(int value)
throws NotesException
Legal values
An integer value representing a font size
STYLE_NO_CHANGE to maintain the previous state
Data typea
IntegerA
Click here to see this topic
See examples
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Creates a new document in the given database, containing a rendering (picture) of a specified document in the newsletter's collection. This is similar to forwarding a document, which displays a picture of the forwarded document.
Defined in
Click here to see this topic
lotus.notes.Newsletter
Click here to see this topic
Syntax
public lotus.notes.Document formatDocument(lotus.notes.Database db, int index)
throws NotesException
Parameters
Click here to see this topic
lotus.notes.Database
Click here to see this topic
The database in which to create the newsletter document. If you do not specify a
lotus.notes.Database,F
the document is created in the user's default mail database.
int indexF
A number indicating the document to render. Use 1 to indicate the first document in the collection, 2 to indicate the second document, and so on.e
Return value
Click here to see this topic
lotus.notes.Document
Click here to see this topic
A document in
containing a rendering of the
th document in the collection.
The rendering is placed into the Body item.
Usage
If you want to save the rendered document, you must explicitly call the
Click here to see this topic
save methodl
Click here to see this topic
on the lotus.notes.Document. The document is saved to the Notes database
you specify.
If you want to mail the rendered document, you must explicitly call the
Click here to see this topic
send method
Click here to see this topic
on the lotus.notes.Document.
Click here to see this topic
See examples
Click here to see this topic
See related topics
Click here to see this topic
lotus.notes.Database class
Click here to see this topic
Click here to see this topic
lotus.notes.Document class
Click here to see this topic
Click here to see this topic
lotus.notes.DocumentCollection class
Click here to see this topic
Click here to see this topic
Making a Notes newsletter
Click here to see this topic
Click here to see this topic
save method
Click here to see this topic
Click here to see this topic
send method
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Creates a newsletter document in the given database that contains a link to each document in the newsletter's collection.
Defined in
Click here to see this topic
lotus.notes.Newsletter
Click here to see this topic
Syntax
public lotus.notes.Document formatMsgWithDoclinks(lotus.notes.Database db)
throws NotesException
Parametert
Click here to see this topic
lotus.notes.Database
Click here to see this topic
The database in which to create the newsletter document. If you specify this parameter as null
the document is created in the user's default mail database.
Return value
Click here to see this topic
lotus.notes.Document
Click here to see this topic
A document that contains a link to each document in the newsletter's collection; also contains the name of
and the text of the original query that produced the collection, if any.p
Usage
The Body item of the returned Notes database contains the following:
The file name of the database that contains the documents in the newsletter's collection.
A link to each document in the newsletter's collection.
If the collection is sorted and the DoScore property is true, the relevance score of each document.e
If the DoSubject property is true and the SubjectItemName property has a value, a title for each document. You must set these properties before calling the formatMsgWithDoclinks method.
The query that produced the newsletter's collection.
If you want to save the newsletter, you must explicitly call the
Click here to see this topic
save method
Click here to see this topic
of lotus.notes.Document. The document is saved to the Notes database you specify.
If you want to mail the newsletter, you must explicitly call the
Click here to see this topic
send methodF
Click here to see this topic
of lotus.notes.Document.
Click here to see this topic
See examples
Click here to see this topic
See related topics
Click here to see this topic
IsDoScore property
Click here to see this topic
Click here to see this topic
IsDoSubject property
Click here to see this topic
Click here to see this topic
lotus.notes.Database class
Click here to see this topic
Click here to see this topic
lotus.notes.Document class
Click here to see this topic
Click here to see this topic
Making a Notes newsletterM
Click here to see this topic
Click here to see this topic
save methods
Click here to see this topic
Click here to see this topic
send methodA
Click here to see this topic
Click here to see this topic
SubjectItemName property
Click here to see this topic
1l8ps
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. All the forms in a database.
Click here to see this topic
lotus.notes.Database
Click here to see this topic
Data type
Object of type java.util.Vector whose elements are objects of type c
Click here to see this topic
lotus.notes.Form
Click here to see this topic
Syntax
public java.util.Vector getForms()
throws NotesException
Click here to see this topic
See examples
See related topics
Click here to see this topic
lotus.notes.Form class
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. The @function formula for a column, if it exists.
Defined in
Click here to see this topic
lotus.notes.ViewColumn
Click here to see this topic
Data typel
Object of type java.lang.Stringe
Syntax
public String getFormula()
throws NotesException
Usage
If a column displays a field value, this property returns an empty string (""). If the database designer gives the column an @function formula that consists of a single field value, this property returns an empty string. You can access the field name with the ItemName property.
If a column displays a simple function, this property returns the @function formula equivalent. For example, if a column displays the simple function Creation Date, the property returns "@Created."
If a column displays an @function formula, this property returns the entire formula.
Click here to see this topic
See examples
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-write. The contents of the $FormUsers field.e
Defined in
Click here to see this topic
lotus.notes.Form
Click here to see this topic
Data types
Object of type java.util.Vector whose elements are objects of type java.lang.String
Syntax
public java.util.Vector getFormUsers()
throws NotesException
public void setFormUsers(java.util.Vector users)
throws NotesException
Usage
Setting this property replaces prior values.
Click here to see this topic
See examples
Click here to see this topic
See related topics
Click here to see this topic
IsProtectUsers property
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Searches for free time slots for calendaring and scheduling.
Defined in
Click here to see this topic
lotus.notes.Session
Click here to see this topic
Syntax
public java.util.Vector freeTimeSearch(lotus.notes.DateRange window, int duration, Object names, boolean firstfit)
throws NotesException
Parameters
lotus.notes.DateRange window
Starting and ending times within which to search for a match.l
int duration
The length in minutes of the free-time interval you want to schedule.
Object names
The name or names of the people or groups whose free time you want to schedule._
boolean firstfit
True if you just want the first matching date range. False if you want all matching times. Defaults to false.
Return value
java.util.Vector
Each member of the vector is a lotus.notes.DateRange object. The vector is null if there are no matches.
Click here to see this topic
See examples
See related topics
Click here to see this topic
lotus.notes.DateRange classJ
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. The full text search score of a document, if it was retrieved as part of a full text search.w
Defined in
Click here to see this topic
lotus.notes.Document
Click here to see this topic
Data type
Syntax
public int getFTSearchScore()
throws NotesException
Usages
The score is determined by the number of target words that are found in the document, the term weights assigned to the target words, and any proximity operators in the search query. If the document is not retrieved as part of a full text search, returns 0. If the document is retrieved using an FTSearch method on a database without a full text index, returns an unpredictable number.
Click here to see this topic
See examples
See related topics
Click here to see this topic
FTSearch method
Click here to see this topic
Click here to see this topic
FTSearch method
Click here to see this topic
Click here to see this topic
IsFTIndexed property
Click here to see this topic
Click here to see this topic
LastFTIndexed property
Click here to see this topic
Click here to see this topic
unprocessedFTSearch method
Click here to see this topic
Click here to see this topic
updateFTIndex method
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Conducts a full text search of all the documents in a Notes database collection, and reduces the collection to those documents that match.
Defined in
Click here to see this topic
lotus.notes.DocumentCollection
Click here to see this topic
Syntax
public void FTSearch(String query, int maxdocs)
throws NotesException<
Parameters
String query
The full text query. See below for the syntax.
int maxdocsP
The maximum number of documents you want returned from the query. Set this parameter to 0 to receive all matching documents.
Usage.
The collection of documents that match the full-text query are sorted by relevance with highest relevance first. You can access the relevance score of each document in the collection using the FTSearchScore property in lotus.notes.Document.
If the database is not full text indexed, this method works, but less efficiently. To test for an index, use the IsFTIndexed property. To create an index on a local database, use the UpdateFTIndex method.
This method searches all of the documents in a document collection. To search all of the documents in a database, use the FTSearch method in lotus.notes.Database. To search only documents found in a particular view, use the FTSearch method in lotus.notes.View.
Query syntax
The syntax rules for a search query are as follows. Use parentheses to override precedence and to group operations.D
Plain text -- To search for a word or phrase, enter the word or phrase as is, except that search keywords and symbols must be enclosed in quotes. To be on the safe side, enclose all search text in quotes. Remember to use double-quotes if you are inside a LotusScript literal.
Wildcards -- Use ? to match any single character in any position in a word. Use * to match zero-to-many characters in any position in a word.
Hyphenated words -- Use hyphenated words to find two-word pairs that are hyphenated, run together as a single word, or separated with a space.
Logical operators -- Use logical operators to expand or restrict your search. The operators and their precedence are
), o
), C
accrue
), and
). You can use either the keyword or symbol.
Proximity operators -- Use proximity operators to search for words that are close to each other. These operators require word, sentence, and paragraph breaks in a full-text index. The operators are
near
sentence
, and
paragraphT
Field operator -- Use the field operator to restrict your search to a specified field. The syntax is t
FIELD
field-name operator
, where
operator
is
contains
for text and rich text fields, and is one of the following for number and date fields:
Exactcase operator -- Use the
exactcase
operator to restrict a search for the next expression to the specified case.m
Termweight operator -- Use the
termweight F
operator to adjust the relevance ranking of the expression that follows, where
is 0-100.
Click here to see this topic
See examples
See related topics
Click here to see this topic
FTSearch methodx
Click here to see this topic
Click here to see this topic
FTSearch method
Click here to see this topic
Click here to see this topic
FTSearchScore property
Click here to see this topic
Click here to see this topic
IsFTIndexed property
Click here to see this topic
Click here to see this topic
LastFTIndexed property
Click here to see this topic
Click here to see this topic
unprocessedFTSearch method
Click here to see this topic
Click here to see this topic
updateFTIndex method
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. The generation part of a name, for example, "Jr," or null if the property is undefined
Conducts a full text search of all the documents in a database.
Defined in
Click here to see this topic
lotus.notes.Database
Click here to see this topic
Syntax
public lotus.notes.DocumentCollection FTSearch(String query)
throws NotesException
public lotus.notes.DocumentCollection FTSearch(String query, int max)
throws NotesException
public lotus.notes.DocumentCollection FTSearch(String query, int max, int sortopt, int otheropt)
throws NotesException
Parameters
String query
The full text query. See below for the syntax.
int max
The maximum number of documents you want returned from the query. Set this parameter to 0 to receive all matching documents.
sortopt
Integer. Optional. Use one of three constants (qualified by the class name) to specify a sorting option:
FT_SCORES (default) sorts by relevance score.
FT_DATE_DES sorts by document creation date in descending order.
FT_DATE_ASC sorts by document creation date in ascending order.F
otheropt
Integer. Optional. Use one of two constants (qualified by the class name) to specify additional search options:
FT_STEMS uses stem words as the basis of the search.
FT_THESAURUS uses the thesaurus to search.
You can use both options together by specifying FT_STEMS + FT_THESAURUS
Return value
lotus.notes.DocumentCollection
A collection of documents that match the full-text query, sorted by the selected option. When the collection is sorted by relevance the highest relevance appears first. To access the relevance score of each document in the collection, use the FTSearchScore property in lotus.notes.Document.
Usage
If the database is not full text indexed, this method works, but less efficiently. To test for an index, use the IsFTIndexed property. To create an index on a local database, use the UpdateFTIndex method.
This method searches all documents in a database. To search only documents found in a particular view, use the FTSearch method in lotus.notes.View. To search only documents found in a particular document collection, use the FTSearch method in lotus.notes.DocumentCollection.
If you don't specify any sort options, you get the documents sorted by relevance score. If you ask for a sort by date, you don't get relevance scores. If you pass the resulting DocumentCollection to a lotus.notes.Newsletter instance, it formats its doclink report with either the document creation date or the relevance score, depending on the sort options you use.
If the database has a multi-database index, you get a multi-database search. Navigation through the resulting document collection may be slow, but you can create a newsletter from the collection.
Query syntax
These are the syntax rules for a search query. Use parentheses to override precedence and to group operations.
Plain text -- To search for a word or phrase, enter the word or phrase as is, except that search keywords and symbols must be enclosed in quotes. It's better to enclose all search text in quotes. Remember to use double-quotes if you are inside a LotusScript literal.
Wildcards -- Use o
to match any single character in any position in a word. Use
to match zero-to-many characters in any position in a word.
Hyphenated words -- Use hyphenated words to find two-word pairs that are hyphenated, run together as a single word, or separated with a space.
Logical operators -- Use logical operators to expand or restrict your search. The operators and their precedence are
accrue
), and
(|). You can use either the keyword or symbol.
Proximity operators -- Use proximity operators to search for words that are close to each other. These operators require word, sentence, and paragraph breaks in a full-text index. The operators are
near
sentence
, and
paragraph
Field operator -- Use the field operator to restrict your search to a specified field. The syntax is
FIELD
field-name operator
, where
operator
is
contains
for text and rich text fields, and is one of the following for number and date fields:
Exactcase operator -- Use the
exactcaset
operator to restrict a search for the next expression to the specified case._
Termweight operator -- Use the
termweight D
operator to adjust the relevance ranking of the expression that follows, where
is 0-100.
Click here to see this topic
See examples
See related topics
Click here to see this topic
FTSearch methodd
Click here to see this topic
Click here to see this topic
FTSearch methoda
Click here to see this topic
Click here to see this topic
FTSearchScore property
Click here to see this topic
Click here to see this topic
IsFTIndexed property
Click here to see this topic
Click here to see this topic
LastFTIndexed property
Click here to see this topic
Click here to see this topic
lotus.notes.DocumentCollection class
Click here to see this topic
Click here to see this topic
unprocessedFTSearch method
Click here to see this topic
Click here to see this topic
updateFTIndex method
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Conducts a full text search on all documents in a view and filters the view so it represents only those documents that match the full text query. This method does not find word variants.
Defined in
Click here to see this topic
lotus.notes.View
Click here to see this topic
Syntax
public int FTSearch(String query)
throws NotesException
public int FTSearch(String query, int maxdocs)
throws NotesException
Parameter
String query
The full text query. See below.
int maxdocsO
The maximum number of documents you want returned from the search. If you want to receive all documents that match the query, specify 0.
Return value
The number of documents in the view after the search. Each of these documents matches the query.
Usage_
If the database is not full-text indexed, this method works, but less efficiently. To test for an index, use the IsFTIndexed property. To create an index on a local database, use the UpdateFTIndex method.
After calling FTSearch, you can use the regular lotus.notes.View methods to navigate the view. The methods navigate to a subset of the documents in the view. For example, GetFirstDocument returns the first document in the view that matches the full text query. GetLastDocument returns the last document in the view that matches the full text query, and so on.
Use the Clear method to clear the full text search filtering. The lotus.notes.View methods now navigate to the full set of documents in the view.
Query syntax
The syntax rules for a search query are as follows. Use parentheses to override precedence and to group operations.
Plain text -- To search for a word or phrase, enter the word or phrase as is, except that search keywords and symbols must be enclosed in quotes. To be on the safe side, enclose all search text in quotes. Remember to use double-quotes if you are inside a LotusScript literal.&
Wildcards -- Use ? to match any single character in any position in a word. Use * to match zero-to-many characters in any position in a word.
Hyphenated words -- Use hyphenated words to find two-word pairs that are hyphenated, run together as a single word, or separated with a space.
Logical operators -- Use logical operators to expand or restrict your search. The operators and their precedence are a
accrue
), and e
). You can use either the keyword or symbol.
Proximity operators -- Use proximity operators to search for words that are close to each other. These operators require word, sentence, and paragraph breaks in a full-text index. The operators are
near
sentence
, and
paragraph
Field operator -- Use the field operator to restrict your search to a specified field. The syntax is
FIELD
field-name operator
, where
operator
is
contains
for text and rich text fields, and is one of the following for number and date fields:
Exactcase operator -- Use the
exactcase
operator to restrict a search for the next expression to the specified case.
Termweight operator -- Use the
termweight
operator to adjust the relevance ranking of the expression that follows, where
is 0-100.
Click here to see this topic
See examples
See related topics
Click here to see this topic
clear method
Click here to see this topic
Click here to see this topic
FTSearch method
Click here to see this topic
Click here to see this topic
FTSearch method
Click here to see this topic
Click here to see this topic
FTSearchScore property
Click here to see this topic
Click here to see this topic
IsFTIndexed property
Click here to see this topic
Click here to see this topic
LastFTIndexed property
Click here to see this topic
Click here to see this topic
updateFTIndex method
Click here to see this topic
D{_es
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Finds an agent in a database, given the agent name.
Defined in
Click here to see this topic
lotus.notes.Database
Click here to see this topic
Syntax
public lotus.notes.Agent getAgent(String name)
throws NotesException
ParameterH
String name
The name of the agent.
Return value
lotus.notes.Agent
The agent whose name matches the parameter.P
Usage
For more information, see the lotus.notes.Agent classi
Click here to see this topic
See examples
See related topics
Click here to see this topic
lotus.notes.Agent class
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Finds documents based on their column values within a view. You create an array of strings (keys), where each key corresponds to a value in a sorted column in the view. The method returns all documents whose column values match each key in the array.
Defined in
Click here to see this topic
lotus.notes.View
Click here to see this topic
Syntax
public lotus.notes.DocumentCollection getAllDocumentsByKey(java.util.Vector keys)
throws NotesException
public lotus.notes.DocumentCollection getAllDocumentsByKey(Object key)
throws NotesException
public lotus.notes.DocumentCollection getAllDocumentsByKey(java.util.Vector keys, boolean exact)
throws NotesException
public lotus.notes.DocumentCollection getAllDocumentsByKey(Object key, boolean exact)
throws NotesException
Parameters
java.util.Vector keysi
Each element in the vector contains a string (java.lang.String object) that is compared to a sorted column in the view. The first element in the vector is compared to the first sorted column in the view; the second element is compared to the second sorted column; and so on.
Object key
A value that is compared to the first sorted column in the view.
boolean exactp
Specify true if you want to find an exact match. If you specify false or omit this parameter, a partial match succeeds.
Return value
lotus.notes.DocumentCollection
All documents in the view whose column values match each of the strings in .
keyArray
. If no documents match, the collection is empty and the count is zero.
Usage
This method returns all the documents whose column values match the strings you indicate. To locate just the first document, use GetDocumentByKey.
Documents found with this method don't have a ColumnValues property. If this is a problem, use GetDocumentByKey followed by a GetNextDocument loop.
Click here to see this topic
See exampleR
See related topics
Click here to see this topic
ColumnValues propertyD
Click here to see this topic
Click here to see this topic
IsCategory property
Click here to see this topic
Click here to see this topic
IsSorted property
Click here to see this topic
Click here to see this topic
lotus.notes.Document class
Click here to see this topic
Click here to see this topic
lotus.notes.DocumentCollection class
Click here to see this topic
Click here to see this topic
lotus.notes.ViewColumn class
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Given the name of a file attachment, returns a lotus.notes.EmbeddedObject representing the attachment. You can use this method to find file attachments which are not contained in a rich text item (such as an attachment in a Release 2 database), as well as file attachments that are contained in a rich text item.
Define in
Click here to see this topic
lotus.notes.Document
Click here to see this topic
Syntax
public lotus.notes.EmbeddedObject getAttachment(String filename)
throws NotesException
Parametere
String filenamei
String. The name of the file attachment you want.c
Return value
lotus.notes.EmbeddedObject
A lotus.notes.EmbeddedObject that represents the file attachment. Returns null if an attachment by the specified name is not found._
UsageE
The Parent property for the returned lotus.notes.EmbeddedObject returns null, since it was not accessed through a lotus.notes.RichTextItem.t
Click here to see this topic
See examples
See related topics
Click here to see this topic
EmbeddedObjects property
Click here to see this topic
Click here to see this topic
EmbeddedObjects property
Click here to see this topic
Click here to see this topic
embedObject method
Click here to see this topic
Click here to see this topic
getEmbeddedObject method
Click here to see this topic
Click here to see this topic
lotus.notes.EmbeddedObject class
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Given a document in a view, returns the first response to the document.
Defined in
Click here to see this topic
lotus.notes.View
Click here to see this topic
Syntax
public lotus.notes.Document getChild(lotus.notes.Document doc)
throws NotesException
Parameter
lotus.notes.Document doc
Any document in the view.
Return value
lotus.notes.Document
The first response document to the
lotus.notes.Document
parameter you specify. Returns null if there are no responses to the document.s
Usage
To find additional response documents, use getNextSibling. The combination of getChild and getNextSibling lets you access a document's responses, sorted in the same order that they appear in a view. To get all of a document's immediate responses, unsorted, use the Responses property in lotus.notes.Document.
If you've filtered the view with the FTSearch method, getChild returns the next document in the view.
Click here to see this topic
See example
See related topics
Click here to see this topic
getNextDocument method
Click here to see this topic
Click here to see this topic
getNextSibling methods
Click here to see this topic
Click here to see this topic
getParentDocument method
Click here to see this topic
Click here to see this topic
lotus.notes.Document class
Click here to see this topic
Click here to see this topic
Responses property
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Creates a lotus.notes.Database object that represents the database located at the server and file name you specify, and opens the database, if possible.
Defined in
Click here to see this topic
lotus.notes.Sessiona
Click here to see this topic
Syntax
public lotus.notes.Database getDatabase(String server, String db)
throws NotesExceptione
Parameters
String server
The name of the server on which the database resides. Use null to indicate a local database.
String dbn
The file name and location of the database within the Notes data directory. Use a full path name if the database is not within the Notes data directory.
Return value
Click here to see this topic
lotus.notes.Database
Click here to see this topic
A lotus.notes.Database object that can be used to access the database you've specified.
Usageh
See the
Click here to see this topic
lotus.notes.Database
Click here to see this topic
class for descriptions and examples.p
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Creates a new lotus.notes.DbDirectory object using the name of the server you want to access.o
Defined in
Click here to see this topic
lotus.notes.Session
Click here to see this topic
Syntax
public lotus.notes.DbDirectory getDbDirectory(String server)
throws NotesException
Parameter
String server
The name of the server whose database files you want to navigate. Use null to indicate the local Notes directory.
Return value
Click here to see this topic
lotus.notes.DbDirectory
Click here to see this topic
The directory on the server you specified.
Usage
See the
Click here to see this topic
lotus.notes.DbDirectoryM
Click here to see this topic
class for descriptions and examples.
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Finds a document in a database, given the document NoteID.
Defined in
Click here to see this topic
lotus.notes.Database
Click here to see this topic
Syntax
public lotus.notes.Document getDocumentByID(String noteid)
throws NotesException
Parameters
String noteid
The NoteID of a document. You can obtain this from the NoteID property of a document.
Return value
lotus.notes.Document
The document whose NoteID matches
noteID
Usage
For an explanation of NoteIDs, see the NoteID property in lotus.notes.Document.h
Click here to see this topic
See examples
See related topics
Click here to see this topic
getDocumentByUNID method
Click here to see this topic
Click here to see this topic
lotus.notes.Document class
Click here to see this topic
Click here to see this topic
NoteID propertye
Click here to see this topic
Click here to see this topic
UniversalID property
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Finds a document based on its column values within a view. You create an array of strings (keys), where each key corresponds to a value in a sorted column in the view. The method returns the first document whose column values match each key in the array.
Defined in
Click here to see this topic
lotus.notes.View
Click here to see this topic
Syntax
public lotus.notes.Document getDocumentByKey(java.util.Vector keys)
throws NotesException
public lotus.notes.Document getDocumentByKey(Object key)
throws NotesException
public lotus.notes.Document getDocumentByKey(java.util.Vector keys, boolean exact)
throws NotesException
public lotus.notes.Document getDocumentByKey(Object key, boolean exact)
throws NotesException
Parameters
java.util.Vector keysn
Each element in the vector contains a string (java.lang.String) that is compared to a sorted column in the view. The first element in the vector is compared to the first sorted column in the view; the second element is compared to the second sorted column; and so on.
Object key
A value that is compared to the first sorted column in the view.
boolean exactt
Specify true if you want to find an exact match. If you specify false (the default) or omit this parameter, a partial match succeeds.
Return value
lotus.notes.Document
The first document in the view whose column values match each of the strings in
keyArray
Usagea
This method returns only the first document whose column values match the strings you indicate. To locate all matching documents, use getAllDocumentsByKey, or use this method followed by a getNextDocument loop.
Click here to see this topic
See examples
See related topics
Click here to see this topic
ColumnValues property
Click here to see this topic
Click here to see this topic
getAllDocumentsByKey method
Click here to see this topic
Click here to see this topic
getNextDocument method
Click here to see this topic
Click here to see this topic
IsCategory propertyg
Click here to see this topic
Click here to see this topic
IsSorted property
Click here to see this topic
Click here to see this topic
lotus.notes.Document class
Click here to see this topic
Click here to see this topic
lotus.notes.ViewColumn class
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Finds a document in a database, given the document universal ID (UNID).
Defined in
Click here to see this topic
lotus.notes.Database
Click here to see this topic
Syntax
public lotus.notes.Document getDocumentByUNID(String unid)
throws NotesException
Parameters
String unid
The universal ID of a document. You can obtain this from the UniversalID or ParentDocumentUNID property of a document.
Return Values
lotus.notes.Document
lotus.notes.Document. The document whose universal ID matches
unid
Usage
For an explanation of universal IDs, see the UniversalID property in lotus.notes.Document.
Click here to see this topic
See examples
See related topics
Click here to see this topic
getDocumentByID method
Click here to see this topic
Click here to see this topic
lotus.notes.Document class
Click here to see this topic
Click here to see this topic
NoteID property
Click here to see this topic
Click here to see this topic
ParentDocumentUNID propertyg
Click here to see this topic
Click here to see this topic
UniversalID property
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Instantiates a document in the Web Navigator database and returns a lotus.notes.Document object for it. You can use this method for either the Server Web Navigator or Personal Web Navigator database.
Defined in
Click here to see this topic
lotus.notes.Database
Click here to see this topic
Syntax
public lotus.notes.Document getDocumentByURL(String url, int reload)
The desired uniform resource locator (URL), for example, http://www.acme.com. You can enter a maximum string length of 15K.
boolean reload
True to reload the page from its Internet server. False to load the page from the Internet only if it is not already in the Web Navigator database.h
boolean relifmod
True to reload the page only
if it has been modified on its Internet server. False to load the page from the Internet only if it is not already in the Web Navigator database.
boolean urllistM
Web pages can contain URL links to other Web pages. You can specify whether to save the URLs in a field called URLLinksC
in the Notes document. (The Web Navigator creates a new URLLinks
field each time the field size reaches 64K. For example, the first URLLinks field is URLLinks1, the second is URLLinks2, and so on.)
Specify true if you want to save the URLs in the URLLinks
field(s). Specify false or omit this parameter if you do not want to save the URLs in the URLLinks
field(s). If you save the URLs, you can use them in agents. For example, you can create an agent that opens Web pages in the Web Navigator database and then loads all the Web pages saved in each of the URLLinks
field(s).
Caution
Saving URLs in the URLLinksa
field(s) may affect performance.
String charset
Enter the MIME character set (for example, ISO-2022-JP for Japanese or ISO-8859-1 for United States) that you want the Web Navigator to use when processing the Web page.
String webuser
Some Internet servers require you to obtain a username before you can access their pages. This parameter allows you to enter the username that you previously obtained from the Internet server.
String webpasswd
Some Internet servers require you to obtain a password before you can access their pages. This parameter allows you to enter the password that you previously obtained from the Internet server.
String proxyuser
Some proxy servers require that you specify a username in order to connect through them. This parameter allows you to enter the username for the proxy server. See your administrator for the username required by the proxy.
String proxypasswd
Some proxy servers require that you specify a password in order to connect through them. This parameter allows you to enter the password for the proxy server. See your administrator for the password required by the proxy.n
boolean nowait
Specify true to return immediately and not wait for completion of the retrieval. If you specify true, getDocumentByURL does not return the Document object representing the URL document. This parameter is useful for offline storage purposes; in this case, you not need the Document object and not have to wait for completion of the operation.
Return value
lotus.notes.Document
The Notes document that represents the URL document you specified.
See related topics
Click here to see this topic
getURLDatabase methodt
Click here to see this topic
Click here to see this topic
getURLHeaderInfo method
Click here to see this topic
Click here to see this topic
lotus.notes.Document class
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Given the name of a file attachment, embedded object, or object link in a rich text item, returns the corresponding lotus.notes.EmbeddedObject.,
Note
GetEmbeddedObject is not supported under OS/2, under UNIX, and on the Macintosh.
Defined in
Click here to see this topic
lotus.notes.RichTextItem
Click here to see this topic
Syntax
public lotus.notes.EmbeddedObject getEmbeddedObject(String name)
throws NotesException
Parametera
String namel
String. The name of the object to find.
To find a file attachment, specify its file name.
To find an embedded object or object link, use the name of the object or link as it appears in the InfoBox, or as designated in the EmbedObject method.
Return value
lotus.notes.EmbeddedObject
The object, if found. Otherwise, returns null.
Usage
If you modify the object returned by GetEmbeddedObject in your script, the changes are saved but the rendering of the object in the Notes document is not updated until you manually activate the object.t
Click here to see this topic
See examples
See related topics
Click here to see this topic
EmbeddedObjects property
Click here to see this topic
Click here to see this topic
EmbeddedObjects property
Click here to see this topic
Click here to see this topic
embedObject method
Click here to see this topic
Click here to see this topic
getAttachment method
Click here to see this topic
Click here to see this topic
HasEmbedded property
Click here to see this topic
Click here to see this topic
lotus.notes.EmbeddedObject class
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Given a name, finds its entry in an ACL.
Defined in
Click here to see this topic
lotus.notes.ACLe
Click here to see this topic
Syntax
public lotus.notes.ACLEntry getEntry(String ename)
throws NotesException
Parameter
String ename
The name whose ACL entry you want to find. The name must be an exact match, apart from case.
Return value
lotus.notes.ACLEntry
The ACL entry that matches t
name
. If
name
is not in the ACL, returns null.l
Usage
GetEntry can find people, groups, or servers in an ACL. If a person is not listed explicitly in the ACL, but is a member of a group that's listed in the ACL, GetEntry does not find that person's name. If you need this capability, use the QueryAccess method in lotus.notes.Database.
Click here to see this topic
See examples
See related topics
Click here to see this topic
getFirstEntry method
Click here to see this topic
Click here to see this topic
getNextEntry method
Click here to see this topic
Click here to see this topic
lotus.notes.ACLEntry class
Click here to see this topic
Click here to see this topic
queryAccess method
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Given the name of a string environment variable, retrieves its value.
Defined in
Click here to see this topic
lotus.notes.Sessionf
Click here to see this topic
Syntax
public String getEnvironmentString(String vname)
throws NotesException
public String getEnvironmentString(String vname, boolean issystem)
throws NotesException
Parameters
String vname
The name of the environment variable to get.
boolean issystem
If true, the method uses the exact name of the environment variable. If false, the method prepends "$" to the name before retrieving its value.
Return value
String
The value of the environment variable.
Usage
This method retrieves the environment variable from the local NOTES.INI (or Notes Preferences) file.
Click here to see this topic
See examples
Click here to see this topic
See related topics
Click here to see this topic
getEnvironmentValue method
Click here to see this topic
Click here to see this topic
setEnvironmentVar method
Click here to see this topic
Click here to see this topic
Using environment variables
Click here to see this topic
6db<}
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Given the name of a numeric environment variable, retrieves its value.
Defined in
Click here to see this topic
lotus.notes.Sessionp
Click here to see this topic
Syntax
public Object getEnvironmentValue(String vname)
throws NotesException.
public Object getEnvironmentValue(String vname, boolean issystem)
throws NotesException
Parameterr
String vname
The name of the environment variable to get.
boolean issystem
If true, the method uses the exact name of the environment variable. If false, the method prepends "$" to the name before retrieving its value.
Return value
Object
The value of the environment variable.
Usage
This method retrieves the environment variable from the local NOTES.INI (or Notes Preferences) file.
Click here to see this topic
See examples
Click here to see this topic
See related topics
Click here to see this topic
getEnvironmentString methodr
Click here to see this topic
Click here to see this topic
setEnvironmentVar method
Click here to see this topic
Click here to see this topic
Using environment variables
Click here to see this topic
6db<}
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Returns the first database on a server (or local computer), using the file type you specify.
Defined in
Click here to see this topic
lotus.notes.DbDirectory
Click here to see this topic
Syntax
public lotus.notes.Database getFirstDatabase(int filetype)
throws NotesException
Parameter
int filetype
Public constant defined in lotus.notes.DbDirectory. Indicates the kind of database file you want to retrieve.u
fileType%o
Indicates
DATABASE
Any Notes database (.nsf, .nsg, or .nsh file)k
TEMPLATE
Any Notes database template (.ntf file)n
REPLICA_CANDIDATE
Any Notes database or template not disabled for replication
TEMPLATE_CANDIDATE
Any Notes database or template
Return value
lotus.notes.Database
The first database, of the specified file type
located in the directory. The database is closed. To open it, use the Open or OpenIfModified method in lotus.notes.Database.
Usagef
Each time you call this method, the database directory is reset and a new search is conducted. If you're searching for template files, for example, a new call to GetFirstDatabase with the parameter DATABASE starts searching the directory from the beginning, this time for database files.s
Click here to see this topic
See examples
See related topics
Click here to see this topic
getNextDatabase method
Click here to see this topic
Click here to see this topic
lotus.notes.Database class
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Gets the first document in a collection.
Defined in
Click here to see this topic
lotus.notes.DocumentCollection
Click here to see this topic
Syntax
public lotus.notes.Document getFirstDocument()
throws NotesException
Return value
lotus.notes.Document
The first document in the collection. If there are no documents in the collection, returns null.
Click here to see this topic
See examples
See related topics
Click here to see this topic
getLastDocument method
Click here to see this topic
Click here to see this topic
getNextDocument method
Click here to see this topic
Click here to see this topic
getNthDocument method
Click here to see this topic
Click here to see this topic
getPrevDocument method
Click here to see this topic
Click here to see this topic
lotus.notes.Document class
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Returns the first document in a view. This is the same document you see when you scroll to the top of the view in the Notes user interface.
Defined in
Click here to see this topic
lotus.notes.View
Click here to see this topic
Syntax
public lotus.notes.Document getFirstDocument()
throws NotesException
Return value
lotus.notes.Document
The first document in the view.
Usage
GetFirstDocument is useful when:
You want to access every document in the view. Use getNextDocument to find documents after the first one.
The first column in the view is sorted by date, and you want to access either the oldest or newest document in the view.
Click here to see this topic
See examples
See related topics
Click here to see this topic
getLastDocument method
Click here to see this topic
Click here to see this topic
getNextDocument method
Click here to see this topic
Click here to see this topic
lotus.notes.Document class
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Returns the first entry in an ACL, usually the -Default- entry.
Defined in
Click here to see this topic
lotus.notes.ACLn
Click here to see this topic
Syntax
public lotus.notes.ACLEntry getFirstEntry()
throws NotesException
Return value
lotus.notes.ACLEntry
The first entry in the ACL._
Click here to see this topic
See examples
See related topics
Click here to see this topic
getEntry method
Click here to see this topic
Click here to see this topic
getNextEntry method
Click here to see this topic
Click here to see this topic
lotus.notes.ACLEntry class
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Given a name, returns the first item of the specified name belonging to the document.
Defined in
Click here to see this topic
lotus.notes.Document
Click here to see this topic
Syntax
public lotus.notes.Item getFirstItem(String name)
throws NotesExceptionE
Parameter
String name
The name of the item you want to find.
Return value
lotus.notes.Item
The first item with
name
. Returns null if the document does not contain an item with
name
Usage
A document may contain more than one item of the same name. To access other than the first item, use the
Click here to see this topic
Items property
Click here to see this topic
If the value of a field is computed for display, the value is not stored as an item. The value is inaccessible from a lotus.notes.Document object, unless the object is accessed as the Document property of NotesUIDocument, and GetFirstItem returns null. In some cases, you can access the field value another way. For example, if a document has a DateComposed field that's computed for display with a formula @Created, use the Created property in lotus.notes.Document.
Using this method to get rich text items
To get a rich text item, explicitly cast the return value from getFirstItem to RichTextItem.
lotus.notes.Document doc;
lotus.notes.RichTextItem rtitem;
//...set value of doc...
rtitem = (RichTextItem)doc.getFirstItem("Body");
Click here to see this topic
See examples
See related topics
Click here to see this topic
copyAllItems methods
Click here to see this topic
Click here to see this topic
copyItem method
Click here to see this topic
Click here to see this topic
getItemValue method
Click here to see this topic
Click here to see this topic
hasItem method
Click here to see this topic
Click here to see this topic
lotus.notes.Item class
Click here to see this topic
Click here to see this topic
removeItem method
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Returns the contents of a rich text item as plain text.
Defined in
Click here to see this topic
lotus.notes.RichTextItem
Click here to see this topic
Syntax
public String getFormattedText(boolean tabstrip, int linelen, int maxlen)
throws NotesException
Parameters
boolean tabstrip
If True, tabs are stripped out of the resulting plain text. If False, tabs are not stripped out.
int linelen
Number of characters at which to wrap lines of text. Set to 0 for the default.
int maxlen
Maximum number of characters to return. Set to 0 for the default.
Return value
String
The contents of the rich text item, as plain text.
UsageE
This method omits non-text data, such as bitmaps and file attachments.
Click here to see this topic
See examples
See related topics
Click here to see this topic
appendText method
Click here to see this topic
Click here to see this topic
Text property
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Finds a form in a database, given the form name.
Defined in
Click here to see this topic
lotus.notes.Database
Click here to see this topic
Syntax
public lotus.notes.Form getForm(String name)
throws NotesException
Parameters
String name
The name or an alias of the form.e
Return value
lotus.notes.Form
The form whose name or alias matches b
name
Click here to see this topic
See examples
See related topics
Click here to see this topic
lotus.notes.Form class
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Gets an ID file from the server.
Defined in
Click here to see this topic
lotus.n
otes.Registration class
Click here to see this topic
Syntax
public void getIDFromServer(String username, String filepath, boolean isserverid)
throws NotesExceptione
Parameters
String usernamex
The username attached to the ID file.
String filepath
The full path of the ID file .
boolean isserverid
True if the name you query represents a server ID. False if the name is that of a person. While the information always comes from the designated server's address book, this argument helps you to choose a view to search.
Click here to see this topic
See examples
See related topics
Click here to see this topic
deleteIDOnServer method
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Given the name of an item with a single double value, returns the value of that item.
Defined in
Click here to see this topic
lotus.notes.Document
Click here to see this topic
Syntax
public double getItemValueDouble(String name)
throws NotesException
Parameterr
String name
The name of the item.
Return value
double
The value of the item.
Click here to see this topic
See examples
See related topics
Click here to see this topic
appendItemValue method
Click here to see this topic
Click here to see this topic
getFirstItem method
Click here to see this topic
Click here to see this topic
hasItem method
Click here to see this topic
Click here to see this topic
replaceItemValue method
Click here to see this topic
Click here to see this topic
Values property
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Given the name of an item with a single integer value, returns the value of that item.
Defined in
Click here to see this topic
lotus.notes.Document
Click here to see this topic
Syntax
public int getItemValueInteger(String name)
throws NotesExceptions
Parametere
String name
The name of the item.
Return value
intd
The value of the item.
Click here to see this topic
See examples
See related topics
Click here to see this topic
appendItemValue method
Click here to see this topic
Click here to see this topic
getFirstItem method
Click here to see this topic
Click here to see this topic
hasItem method
Click here to see this topic
Click here to see this topic
replaceItemValue method
Click here to see this topic
Click here to see this topic
Values property
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Given the name of an item with a single String value, returns the value of that item.
Defined in
Click here to see this topic
lotus.notes.Document
Click here to see this topic
Syntax
public String getItemValueString(String name)
throws NotesException
Parameterr
String name
The name of the item.
Return value
String
The value of the item.
Click here to see this topic
See examples
See related topics
Click here to see this topic
appendItemValue method
Click here to see this topic
Click here to see this topic
getFirstItem method
Click here to see this topic
Click here to see this topic
hasItem method
Click here to see this topic
Click here to see this topic
replaceItemValue method
Click here to see this topic
Click here to see this topic
Values property
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Given the name of an item, returns the value of that item.
Defined in
Click here to see this topic
lotus.notes.Document
Click here to see this topic
Syntax
public java.util.Vector getItemValue(String name)
throws NotesException
Parameter
String namev
The name of an item.
Return value
java.util.Vector
The value or values contained in the item. The data type of the value depends on the data type of the item.
Notes item type
alue return type
Rich text
java.lang.String. The text in the item, rendered into plain text
Text or text list (includes Names, Authors, and Readers item types)l
java.util.Vector with java.lang.String elements
Number or number list
java.util.Vector with double elements
Date-time or range of date-time values
java.util.Vector with lotus.notes.DateTime elementsP
When getItemValue returns a vector, each element corresponds to a value in the item. If the item contains a single value, the vector has just one element.
Click here to see this topic
See examples
See related topics
Click here to see this topic
appendItemValue method
Click here to see this topic
Click here to see this topic
getFirstItem method
Click here to see this topic
Click here to see this topic
hasItem method
Click here to see this topic
Click here to see this topic
replaceItemValue method
Click here to see this topic
Click here to see this topic
Values property
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Gets the last document in a collection.L
Defined in
Click here to see this topic
lotus.notes.DocumentCollection
Click here to see this topic
Syntax
public lotus.notes.Document getLastDocument()
throws NotesException
Return value
lotus.notes.Document
The last document in the collection. If there are no documents in the collection, returns null.
Click here to see this topic
See examples
See related topics
Click here to see this topic
GetFirstDocument method
Click here to see this topic
Click here to see this topic
getNextDocument method
Click here to see this topic
Click here to see this topic
getNthDocument method
Click here to see this topic
Click here to see this topic
getPrevDocument method
Click here to see this topic
Click here to see this topic
lotus.notes.Document class
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Returns the last document in a view. This is the same document you see when you scroll to the bottom of the view in the Notes user interface.
Defined in
Click here to see this topic
lotus.notes.View
Click here to see this topic
Syntax
public lotus.notes.Document getLastDocument()
throws NotesExceptionu
Return value
lotus.notes.Document
The last document in the view.
Usage
This method is useful when:t
The first column in the view is sorted by date, and you want to access either the oldest or newest document in the view.
You want to access every document in the view. Use getPrevDocument to find documents before the last one.]
You write a script that modifies items on mulitple documents, but first you want to test the script against just one document. The last document in the view is often the easiest to locate visually.j
Click here to see this topic
See examples
See related topics
Click here to see this topic
getDocumentByKey methoda
Click here to see this topic
Click here to see this topic
getFirstDocument methodT
Click here to see this topic
Click here to see this topic
getPrevDocument method
Click here to see this topic
Click here to see this topic
lotus.notes.Document class
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Returns the next database in a directory, using the file type specified in the getFirstDatabase method.t
Defined in
Click here to see this topic
lotus.notes.DbDirectoryr
Click here to see this topic
Syntax
public lotus.notes.Database getNextDatabase()
throws NotesExceptione
Return value
lotus.notes.Database
The next database located in the directory. Once you exhaust the directory, returns null. The database is closed. To open it, use the Open or OpenIfModified method in lotus.notes.Database.
Click here to see this topic
See examples
See related topics
Click here to see this topic
getFirstDatabase methoda
Click here to see this topic
Click here to see this topic
lotus.notes.Database class
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Given a document, finds the document immediately following it in a collection.
Defined in
Click here to see this topic
lotus.notes.DocumentCollection
Click here to see this topic
Syntax
public lotus.notes.Document getNextDocument(lotus.notes.Document doc)
throws NotesException
Parameterb
lotus.notes.Document doc
Any document in the collection.M
Return value
lotus.notes.Document
The document following the lotus.notes.Document parameter in the collection. If there is no next document, returns null.
Click here to see this topic
See examples
See related topics
Click here to see this topic
GetFirstDocument methode
Click here to see this topic
Click here to see this topic
getLastDocument method
Click here to see this topic
Click here to see this topic
getNthDocument methode
Click here to see this topic
Click here to see this topic
getPrevDocument method
Click here to see this topic
Click here to see this topic
lotus.notes.Document class
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Given a document in a view, returns the document immediately following it.
Defined in
Click here to see this topic
lotus.notes.View
Click here to see this topic
Syntax
public lotus.notes.Document getNextDocument(lotus.notes.Document doc)
throws NotesExceptionJ
Parameter
lotus.notes.Document doc
Any document in the view.
Return value
lotus.notes.Document
The document following the specified
parameter in the view. Returns null if there are no more documents in the view.
Usage
This method returns the next document in the view regardless of what type of document it is (document, response, or response-to-response). If you want the next sibling document in the view, use getNextSibling.
Click here to see this topic
See examples
See related topics
Click here to see this topic
getFirstDocument method
Click here to see this topic
Click here to see this topic
getNextSibling methodO
Click here to see this topic
Click here to see this topic
getPrevDocument method
Click here to see this topic
Click here to see this topic
lotus.notes.Document class
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Given an ACL entry, returns the next one.
Defined in
Click here to see this topic
lotus.notes.ACLe
Click here to see this topic
Syntax
public lotus.notes.ACLEntry getNextEntry(lotus.notes.ACLEntry entry)
throws NotesException
Parametero
lotus.notes.ACLEntry entry
Any entry in the ACL.
Return value
lotus.notes.ACLEntry
The entry following the specified
lotus.notes.ACLEntry
parameter in the ACL. Returns null if there are no more entries.
Click here to see this topic
See examples
See related topics
Click here to see this topic
getEntry method
Click here to see this topic
Click here to see this topic
getFirstEntry method
Click here to see this topic
Click here to see this topic
lotus.notes.ACLEntry class
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Given a document in a view, returns the document immediately following the given document at the same level. If you send the method a main document, the next main document in the view is returned. If you send a response document, the next response document with the same parent is returned.
If the view is categorized, the next sibling must be in the same category as the original document.
Defined in
Click here to see this topic
lotus.notes.View
Click here to see this topic
Syntax
public lotus.notes.Document getNextSibling(lotus.notes.Document doc)
throws NotesException
Parameter
lotus.notes.Document doc
Any document in the view.
Return value
lotus.notes.Document
The document following the specified =
doc
parameter, at the same level in the view. Returns Nothing if there are no more siblings.
Usage
You can use getNextSibling to:
Move from one main document to the next, skipping any response documents in between
Visit the response documents of a particular parent document (use getChild to find the first response)
Visit the response-to-response documents of a particular parent document (use getChild to find the first response-to-response)
If you have filtered the view with FTSearch, getNextSibling returns the next document in the view, regardless of level.
Siblings
Two documents are siblings if:
They are both main documents, or
They are both responses or response-to-responses and they share the same parent document
The last sibling
This method returns null when the
lotus.notes.Document
parameter is:
The last main document in a view
The last main document in a particular category of a view
The last response (or response-to-response) to a particular parent
Click here to see this topic
See examples
See related topics
Click here to see this topic
FTSearch method
Click here to see this topic
Click here to see this topic
getChild method
Click here to see this topic
Click here to see this topic
getNextDocument method
Click here to see this topic
Click here to see this topic
getPrevSibling method
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Given a position number, returns the document at that position in a collection.
Defined in
Click here to see this topic
lotus.notes.DocumentCollection
Click here to see this topic
Syntax
public lotus.notes.Document getNthDocument(int n)
throws NotesException
Parametero
int nf
Integer. A number indicating the document to return. Use 1 to indicate the first document in the collection, 2 to indicate the second document, and so on.
Return value
lotus.notes.Document
The document in the
th position in the collection. If there is no document at the specified position, returns null.
Click here to see this topic
See examples
See related topics
Click here to see this topic
GetFirstDocument methodB
Click here to see this topic
Click here to see this topic
getLastDocument method
Click here to see this topic
Click here to see this topic
getNextDocument method
Click here to see this topic
Click here to see this topic
getPrevDocument method
Click here to see this topic
Click here to see this topic
lotus.notes.Document class
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Given a number, returns the document at the given position in the top level of a view.
Defined in
Click here to see this topic
lotus.notes.View
Click here to see this topic
Syntax
public lotus.notes.Document getNthDocument(int n)
throws NotesException
Parameter
int n
Integer. A number indicating the document to return. Use 1 to indicate the first document in the view, 2 to indicate the second document, and so on.
Return value
lotus.notes.Document
The document in the
th position in the view.
Usage
This method accesses only top-level (main) documents in a view; response documents are excluded.
This method is most useful when used in combination with the FTSearch method in lotus.notes.View, which returns the number of documents that remain in a view after it's been filtered with a full-text search.
Click here to see this topic
See examples
See related topics
Click here to see this topic
FTSearch method
Click here to see this topic
Click here to see this topic
getDocumentByKey methodE
Click here to see this topic
Click here to see this topic
lotus.notes.Document class
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Given a response document in a view, returns its parent document.
Defined in
Click here to see this topic
lotus.notes.View
Click here to see this topic
Syntax
public lotus.notes.Document getParentDocument(lotus.notes.Document doc)
throws NotesException
Parameter
lotus.notes.Document doc
Any document in the view.
Return value
lotus.notes.Document
The parent of the specified
parameter
(the document to which the o
doc
parameter is a response). If you have filtered the view using FTSearch,getParentDocument simply returns the previous document in the view.F
Usage]
The document returned by getParentDocument may be a main document, a response, or a response-to-response.
To find a document's parent outside of a view, get its ParentDocumentUNID and use the lotus.notes.Database method getDocumentByUNID.
Click here to see this topic
See examples
See related topics
Click here to see this topic
getChild method
Click here to see this topic
Click here to see this topic
getDocumentByUNID method
Click here to see this topic
Click here to see this topic
lotus.notes.Document class
Click here to see this topic
Click here to see this topic
ParentDocumentUNID property
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Given a document, finds the document immediately preceding it in a collection.
Defined in
Click here to see this topic
lotus.notes.DocumentCollection
Click here to see this topic
Syntax
public lotus.notes.Document getPrevDocument(lotus.notes.Document doc)
throws NotesException
Parameter
lotus.notes.Document doc
Any document in the collection.t
Return value
lotus.notes.Document
The document preceding the lotus.notes.Document parameter in the collection. If there is no previous document, returns null.
Click here to see this topic
See examples
See related topics
Click here to see this topic
GetFirstDocument methody
Click here to see this topic
Click here to see this topic
getLastDocument method
Click here to see this topic
Click here to see this topic
getNextDocument method
Click here to see this topic
Click here to see this topic
getNthDocument methods
Click here to see this topic
Click here to see this topic
lotus.notes.Document class
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Given a document in a view, returns the document immediately preceding.
Defined in
Click here to see this topic
lotus.notes.View
Click here to see this topic
Syntax
public lotus.notes.Document getPrevDocument(lotus.notes.Document doc)
throws NotesException
Parameter
lotus.notes.Document doc
Any document in the view.e
Return value
lotus.notes.Document
The document preceding the
parameter you specify. Returns null if there is no preceding document.
Click here to see this topic
See examples
See related topics
Click here to see this topic
getLastDocument method
Click here to see this topic
Click here to see this topic
getNextDocument method
Click here to see this topic
Click here to see this topic
lotus.notes.Document class
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Given a document in a view, returns the document immediately preceding the given document at the same level. If you send the method a main document, the preceding main document in the view is returned. If you send a response document, the preceding response document with the same parent is returned.
If the view is categorized, the previous sibling must be in the same category as the original document.
Defined in
Click here to see this topic
lotus.notes.View
Click here to see this topic
Syntax
public lotus.notes.Document getPrevSibling(lotus.notes.Document doc)
throws NotesException
Parameter
lotus.notes.Document doc
Any document in the view.a
Return value
lotus.notes.Document
The document preceding the
doc
parameter you specify, at the same level. Returns null if there is no previous sibling in the view.
Usage
You can use getPrevSibling to move from one main document to the next, skipping any response documents in between.
If you have filtered the view using FTSearch, getPrevSibling returns the previous document in the view, regardless of level.
Siblings
Two documents are siblings if:
They are both main documents, or
They are both responses or response-to-responses and they share the same parent document..
The first siblinga
This method returns null when the
doc
parameter is:
The first main document in a viewU
The first main document in a particular category of a view
The first response (or response-to-response) to a particular parentd
Click here to see this topic
See examples
See related topics
Click here to see this topic
FTSearch methodi
Click here to see this topic
Click here to see this topic
getChild methodh
Click here to see this topic
Click here to see this topic
getNextSibling method
Click here to see this topic
Click here to see this topic
getParentDocument method
Click here to see this topic
Click here to see this topic
getPrevDocument method
Click here to see this topic
Click here to see this topic
lotus.notes.Document class
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Retrieves or creates a profile document.
Defined in
Click here to see this topic
lotus.notes.Database
Click here to see this topic
Syntax
public lotus.notes.Document getProfileDocument(String profile, String profileuser)
throws NotesException
Parameters
String profile
The name or an alias of the profile document.
String profileuser
The user name (key) attached to the profile document.
Click here to see this topic
See examples
See related topics
Click here to see this topic
IsProfile property
Click here to see this topic
Click here to see this topic
Key property
Click here to see this topic
Click here to see this topic
NameOfProfile property
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Gets the specific Hypertext Transfer Protocol (HTTP) header information from the Uniform Resource Locator (URL). A URL is a text string used for identifying and addressing a Web resource.
The URL for the Web page you want information on, for example, http://www.acme.com/. You can enter a maximum string length of 15K.
String header
Enter a header string of the URL header value you want returned. The acceptable header strings are documented in the HTTP specification (available at various locations on the Internet, such as http://www.w3.org/) and are subject to change based on updated versions of the specification.
webuser$
String. Optional. Some Internet servers require you to obtain a username before you can access their pages. This parameter allows you to enter the username that you previously obtained from the Internet server.
webpasswdt
String. Optional. Some Internet servers require you to obtain a password before you can access their pages. This parameter allows you to enter the password that you previously obtained from the Internet server.
proxyusers
String. Optional. Some proxy servers require that you specify a username in order to connect through them. This parameter allows you to enter the username for the proxy server. See your administrator for the username required by the proxy.
proxypasswd
String. Optional. Some proxy servers require that you specify a password in order to connect through them. This parameter allows you to enter the password for the proxy server. See your administrator for the password required by the proxy.
Return value
String
The requested header. If a null value is returned, the header value that you requested was not found in the header of the URL, or the URL could not be found.
The parameters, except for the first, are return values.
Click here to see this topic
See examples
See related topics
Click here to see this topic
getIDFromServer method
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Finds a view or folder in a database, given the name or alias of the view or folder.
Defined in
Click here to see this topic
lotus.notes.Database
Click here to see this topic
Syntax
public lotus.notes.View getView(String name)
throws NotesException
Parameter
String name
The name of a view or folder in a database. Case insensitive. Use either the entire name of the view or folder (including backslashes for cascading views and folders), or an alias.
Return Values
lotus.notes.View
The view or folder whose name or synonym matches b
name
Usage
If the database is local, GetView returns both public and personal views and folders. If the database is on a server, GetView returns only public views and folders.
When specifying the
name
parameter, do not use the view name and its alias together. For example, specifying "By Author|AuthorView" does not work. Use either the view name ("By Author") or its alias ("AuthorView").
When the view or folder name contains underscores to indicate menu accelerators, you have the option of including or excluding the underscores. The method works more efficiently, however, if you include the underscores.
Click here to see this topic
See examples
See related topics
Click here to see this topic
lotus.notes.View class
Click here to see this topic
Click here to see this topic
Views property
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. The given part of a name, or null if the property is undefined.
Defined in
Click here to see this topic
lotus.notes.Name
class
Click here to see this topic
Data type
String
Syntax
public String getGiven()
throws NotesException
Click here to see this topic
See examples
Click here to see this topic
See related topics
Click here to see this topic
Generation property
Click here to see this topic
Click here to see this topic
Initials property
Click here to see this topic
Click here to see this topic
SurName property
Click here to see this topic
;ZLre
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. A string representing a date-time, converted to Greenwich Mean Time (timezone 0).
Defined in
Click here to see this topic
lotus.notes.DateTime
Click here to see this topic
Data type
String
Syntax
public String getGMTTime()
throws NotesException
Usage
The Greenwich Mean Time value depends upon the IsDST and TimeZone properties of the lotus.notes.DateTime object.
Click here to see this topic
See examples
Click here to see this topic
See related topics
Click here to see this topic
IsDST property
Click here to see this topic
Click here to see this topic
IsDST property
Click here to see this topic
Click here to see this topic
TimeZone property
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Modifies a database access control list to provide the specified level of access to a person, group, or server.e
Defined in
Click here to see this topic
lotus.notes.Database
Click here to see this topic
Syntax
public void grantAccess(String name, int level)
throws NotesException
Parameters
String name
The name of the person, group, or server whose access level you want to provide or change.
int level
The level of access you're granting. This parameter is one of the following constants:
Levele
Meaning
ACLLEVEL_NOACCESS
No access
ACLLEVEL_DEPOSITOR
Depositor access
ACLLEVEL_READERc
Reader access
ACLLEVEL_AUTHORe
Author access
ACLLEVEL_EDITOR
Editor accesso
ACLLEVEL_DESIGNER
Designer accessi
ACLLEVEL_MANAGER
Manager access
Usage
If the name
already exists in the ACL, this method updates it with the access
Otherwise, the name is added to the ACL with the level
You can also use this method to deny access to a person, group, or server by assigning ACLLEVEL_NOACCESS.
This method sets ACL roles to their default values.
Click here to see this topic
See examples
See related topics
Click here to see this topic
CurrentAccessLevel property
Click here to see this topic
Click here to see this topic
lotus.notes.ACL class
Click here to see this topic
Click here to see this topic
lotus.notes.ACLEntry class
Click here to see this topic
Click here to see this topic
queryAccess method
Click here to see this topic
Click here to see this topic
revokeAccess method
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. Indicates if a document contains one or more embedded objects, object links, or file attachments.
Note
HasEmbedded is not supported under OS/2, under UNIX, and on the Macintosh.
Defined in
Click here to see this topic
lotus.notes.Document
Click here to see this topic
Data type
boolean
Syntax
public boolean hasEmbedded()
throws NotesException
Legal values
True
The document contains one or more embedded objects, object links, or file attachments.
Falseh
The document does not contain any embedded objects, object links, or file attachments.
Click here to see this topic
See examples
See related topics
Click here to see this topic
EmbeddedObjects property
Click here to see this topic
Click here to see this topic
EmbeddedObjects property
Click here to see this topic
Click here to see this topic
embedObject method
Click here to see this topic
Click here to see this topic
getAttachment method
Click here to see this topic
Click here to see this topic
getEmbeddedObject method
Click here to see this topic
Click here to see this topic
lotus.notes.EmbeddedObject class
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Given the name of an item, indicates if that item exists on the document.
Defined in
Click here to see this topic
lotus.notes.Document
Click here to see this topic
Syntax
public boolean hasItem(String name)
throws NotesExceptionp
Parameterp
String name
The name of an item.
Return value
boolean
True
An item with
ame
exists in the document.
FalseP
There is no item with
name
in the document.
Click here to see this topic
See examples
See related topics
Click here to see this topic
copyAllItems method
Click here to see this topic
Click here to see this topic
copyItem methodr
Click here to see this topic
Click here to see this topic
getFirstItem method
Click here to see this topic
Click here to see this topic
getItemValue method
Click here to see this topic
Click here to see this topic
lotus.notes.Item class
Click here to see this topic
Click here to see this topic
removeItem method
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-Write. The type of ID file to create when calling
Click here to see this topic
RegisterNewUser
Click here to see this topic
Click here to see this topic
RegisterNewServer"
Click here to see this topic
, and
Click here to see this topic
RegisterNewCertifier
Click here to see this topic
Defined in
Click here to see this topic
lotus.notes.Registration class
Click here to see this topic
Data type
Syntax
public int getIDType()
throws NotesException
public void setIDType(int type)
throws NotesException
Legal Values
ID_FLATW
The created ID is flat.t
ID_HIERACHICAL
The created ID is hierarchical.
ID_CERTIFIER
The created ID is flat or hierarchical depending on whether the certifier ID is flat or hierarchical.
Click here to see this topic
See examples
_PROPERTY_JAVA
See related topics
Click here to see this topic
CertifierIDFile property
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. The initials part of a name, or null if the property is undefined.
Defined in
Click here to see this topic
lotus.notes.Name
class
Click here to see this topic
Data type
String
Syntax
public String getInitials()
throws NotesException
Click here to see this topic
See examples
Click here to see this topic
See related topics
Click here to see this topic
Generation property
Click here to see this topic
Click here to see this topic
Given property
Click here to see this topic
Click here to see this topic
SurName property
Click here to see this topic
;ZLre
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. The international (regional) settings for your operating environment.
Defined in
Click here to see this topic
lotus.notes.Sessioni
Click here to see this topic
Data typeA
Click here to see this topic
lotus.notes.International
Click here to see this topic
Syntax
public lotus.notes.International getInternational()
throws NotesException
Usage
See the
Click here to see this topic
lotus.notes.International
Click here to see this topic
class for descriptions and examples.
See related topics
Click here to see this topic
Accessing international settings
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-Write. For an entry with Author access to a database, indicates if the entry is allowed to create new documents.
Defined in
Click here to see this topic
lotus.notes.ACLEntry
Click here to see this topic
Data type
boolean
Syntax
public boolean isCanCreateDocuments()
throws NotesException
public void setCanCreateDocuments(boolean flag)
throws NotesException
Legal values
True
The entry can create new documents in the database.e
False
The entry cannot create new documents.
Usage
After setting this property, you must call Save on the parent lotus.notes.ACL in order for the changes to take effect. If you do not call Save, your changes to the lotus.notes.ACLEntry are lost.
Setting this property has no effect on an ACL entry unless the entry has Author access to a database. If an entry has Editor, Designer, or Manager access, this property is always True. If an entry has Reader, Depositor, or No access, this property is always False.
Click here to see this topic
See examples
See related topics
Click here to see this topic
IsCanCreatePersonalAgent property
Click here to see this topic
Click here to see this topic
IsCanCreatePersonalFolder property
Click here to see this topic
Click here to see this topic
IsCanDeleteDocuments property
Click here to see this topic
Click here to see this topic
save method
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-write. Indicates whether an item is of type Authors. An Authors item contains a list of Notes user names, indicating people who have Author access to a particular document.
Defined in
Click here to see this topic
lotus.notes.Item
Click here to see this topic
Data type
boolean
Syntax
public boolean isAuthors()
throws NotesException
public void setAuthors(boolean flag)
throws NotesException
Legal values
True
The item is of type Authors.
False
The item is not of type Authors.
Usage
An Authors item is stored as text and its Type property returns TEXT. Use IsAuthors to determine if a text item is also an Authors item.
Click here to see this topic
See examples
See related topics
Click here to see this topic
Authors property
Click here to see this topic
Click here to see this topic
IsNames property
Click here to see this topic
Click here to see this topic
IsReaders property
Click here to see this topic
Click here to see this topic
Type property
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. Indicates whether a view is a calendar view.
Defined in
Click here to see this topic
lotus.notes.View
Click here to see this topic
Data type
booleanA
Syntax
public boolean isCalendar()
throws NotesException
Return value
True
The view is a calendar view
False
The view is a standard outline view
Click here to see this topic
See examples
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. Indicates if a column is categorized.
Defined in
Click here to see this topic
lotus.notes.ViewColumn
Click here to see this topic
Data type
boolean
Syntax
public boolean isCategory()
throws NotesException
Legal values
True
The column is categorized.
Falsei
The column is not categorized.
Usagep
If IsCategory is true, the IsSorted property is also true, since columns that are categorized must also be sorted.
Click here to see this topic
See examples
See related topics
Click here to see this topic
IsSorted propertye
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. Indicates if the currency format has a space between the currency symbol and the number.
Defined in
Click here to see this topic
lotus.notes.International Class
Click here to see this topic
Data type
booleane
Syntax
public boolean isCurrencySpace()
throws NotesException
Legal values
True if the currency format has a space between the currency symbol and the number.
False if the currency format does not have a space between the currency symbol and the number.
Click here to see this topic
See examples
Click here to see this topic
See related topics
Click here to see this topic
Accessing international settings
Click here to see this topic
Click here to see this topic
CurrencySymbol property
Click here to see this topic
Click here to see this topic
IsCurrencySuffix property
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. Indicates if the currency symbol follows the number in the currency format.
Defined in
Click here to see this topic
lotus.notes.International Class
Click here to see this topic
Data type
boolean
Syntax
public boolean isCurrencySuffix()
throws NotesExceptione
Legal values
True if the currency symbol follows the number.
False if the currency symbol precedes the number.
Click here to see this topic
See examples
Click here to see this topic
See related topics
Click here to see this topic
Accessing international settings
Click here to see this topic
Click here to see this topic
CurrencySymbol property
Click here to see this topic
Click here to see this topic
IsCurrencySpace property
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. Indicates if fractions have a zero before the decimal point in number format.
Defined in
Click here to see this topic
lotus.notes.International Class
Click here to see this topic
Data type
boolean
Syntax
public boolean isCurrencyZero()
throws NotesException
Legal values
True if fractions have a zero before the decimal point.
False if fractions do not have a zero before the decimal point.t
Click here to see this topic
See examples
Click here to see this topic
See related topics
Click here to see this topic
Accessing international settings
Click here to see this topic
Click here to see this topic
CurrencyDigits property
Click here to see this topic
Click here to see this topic
DecimalSep property
Click here to see this topic
Click here to see this topic
ThousandsSep property
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. Indicates if the order of the date format is day-month-year.
Defined in
Click here to see this topic
lotus.notes.International Class
Click here to see this topic
Data type
boolean
Syntax
public boolean isDateDMY()
throws NotesException
Legal values
True if the order of the date format is day-month-year.
False if the order of the date format is not day-month-year.
Click here to see this topic
See examples
Click here to see this topic
See related topics
Click here to see this topic
Accessing international settings
Click here to see this topic
Click here to see this topic
DateSep property
Click here to see this topic
Click here to see this topic
IsDateMDY property
Click here to see this topic
Click here to see this topic
IsDateYMD property
Click here to see this topic
Click here to see this topic
IsDST property
Click here to see this topic
Click here to see this topic
IsDST property
Click here to see this topic
Click here to see this topic
Today property
Click here to see this topic
Click here to see this topic
Tomorrow propertyi
Click here to see this topic
Click here to see this topic
Yesterday property
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. Indicates if the order of the date format is month-day-year.
Defined in
Click here to see this topic
lotus.notes.International Class
Click here to see this topic
Data type
boolean
Syntax
public boolean isDateMDY()
throws NotesException
Legal values
True if the order of the date format is month-day-year.
False if the order of the date format is not month-day-year.
Click here to see this topic
See examples
Click here to see this topic
See related topics
Click here to see this topic
Accessing international settings
Click here to see this topic
Click here to see this topic
DateSep property
Click here to see this topic
Click here to see this topic
IsDateDMY property
Click here to see this topic
Click here to see this topic
IsDateYMD property
Click here to see this topic
Click here to see this topic
IsDST property
Click here to see this topic
Click here to see this topic
IsDST property
Click here to see this topic
Click here to see this topic
Today property
Click here to see this topic
Click here to see this topic
Tomorrow property
Click here to see this topic
Click here to see this topic
Yesterday property
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. Indicates if the order of the date format is year-month-day.
Defined in
Click here to see this topic
lotus.notes.International Class
Click here to see this topic
Data type
boolean
Syntax
public boolean isDateYMD()
throws NotesException
Legal values
True if the order of the date format is year-month-day.
False if the order of the date format is not year-month-day.
Click here to see this topic
See examples
Click here to see this topic
See related topics
Click here to see this topic
Accessing international settings
Click here to see this topic
Click here to see this topic
DateSep property
Click here to see this topic
Click here to see this topic
IsDateDMY property
Click here to see this topic
Click here to see this topic
IsDateMDY property
Click here to see this topic
Click here to see this topic
IsDST property
Click here to see this topic
Click here to see this topic
IsDST property
Click here to see this topic
Click here to see this topic
Today property
Click here to see this topic
Click here to see this topic
Tomorrow property
Click here to see this topic
Click here to see this topic
Yesterday property
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. Indicates whether a view is the default view of the database.
Defined in
Click here to see this topic
lotus.notes.View
Click here to see this topic
Data typeN
boolean
Syntax
public boolean isDefaultView()
throws NotesException
Return value
True
The view is the default view
Falsel
The view is not the default view
Click here to see this topic
See examples
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. Indicates if the time reflects daylight savings time.
Defined in
Click here to see this topic
lotus.notes.DateTime
Click here to see this topic
Data typer
booleana
Syntax
public boolean isDST()
throws NotesException
Legal values
true if the current computer is set to observe daylight savings time, and daylight savings time is currently in effect (for example, from mid-April to mid-October)
false if the current computer is set to observe daylight savings time, but daylight savings time is not currently in effect (for example, from mid-October to mid-April); the current computer is not set to observe daylight savings time; the lotus.notes.DateTime object has no time component.
Click here to see this topic
See examples
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. Indicates if the time format reflects daylight savings time.
Defined in
Click here to see this topic
lotus.notes.International
Click here to see this topic
Data typeJ
booleann
Syntax
public boolean isDST()
throws NotesException
Legal values
True if the time format reflects daylight savings time.
False if the time format reflects daylight savings time.
Click here to see this topic
See examples
Click here to see this topic
See related topics
Click here to see this topic
Accessing international settings
Click here to see this topic
Click here to see this topic
DateSep property
Click here to see this topic
Click here to see this topic
IsDateDMY property
Click here to see this topic
Click here to see this topic
IsDateMDY property
Click here to see this topic
Click here to see this topic
IsDateYMD property
Click here to see this topic
Click here to see this topic
Today property
Click here to see this topic
Click here to see this topic
Tomorrow propertyk
Click here to see this topic
Click here to see this topic
Yesterday property
Click here to see this topic
}%ALh:ts
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-write. Indicates if an agent is able to run or not.
Defined in
Click here to see this topic
lotus.notes.Agent
Click here to see this topic
Data type
booleani
Syntax
public boolean isEnabled()
throws NotesException
public void setEnabled(boolean value)
throws NotesExceptionr
Legal values
true if the agent can be run
false if the agent is disabled
Usage
This property is intended for use with scheduled agents, which can be enabled and disabled. This property always returns true for hidden agents and agents that are run from a menu.
You must call
Click here to see this topic
Save
Click here to see this topic
to make any change effective.
If the agent is open in the UI, a change is not immediately reflected. The agent must be closed and reopened.
Click here to see this topic
See examples
Click here to see this topic
jyyxs
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-Write. Indicates if an item is encrypted.
Defined in
Click here to see this topic
lotus.notes.Item
Click here to see this topic
Data type
boolean
Syntax
public boolean isEncrypted()
throws NotesException
public void setEncrypted(boolean flag)
throws NotesException
Legal values
True
The item is encrypted.
False
The item is not encrypted.
Usage
If you set this property to true, the item is not actually encrypted until you call the Encrypt method on the parent lotus.notes.Document.
Click here to see this topic
See examples
See related topics
Click here to see this topic
encrypt method
Click here to see this topic
Click here to see this topic
EncryptionKeys property
Click here to see this topic
Click here to see this topic
IsEncryptOnSend property
Click here to see this topic
Click here to see this topic
IsProtected property
Click here to see this topic
Click here to see this topic
IsSigned property
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. Indicates whether a lotus.notes.View object represents a folder.
Defined in
Click here to see this topic
lotus.notes.View
Click here to see this topic
Data type
boolean
Syntax
public boolean isFolder()
throws NotesExceptionl
Return value
True
The lotus.notes.View object represents a folder.
False
The lotus.notes.View object represents a view.
Click here to see this topic
See examples
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. Indicates whether or not a database has a full text index.
Defined in
Click here to see this topic
lotus.notes.Database
Click here to see this topic
Data type
boolean
Syntax
public boolean isFTIndexed()
throws NotesException
Legal values
True
The database has a full text index.
False@
The database does not have a full text index.
Click here to see this topic
See examples
See related topics
Click here to see this topic
FTSearch method
Click here to see this topic
Click here to see this topic
FTSearch method
Click here to see this topic
Click here to see this topic
FTSearchScore property
Click here to see this topic
Click here to see this topic
LastFTIndexed property
Click here to see this topic
Click here to see this topic
unprocessedFTSearch method
Click here to see this topic
Click here to see this topic
updateFTIndex method
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. Indicates if a column is hidden.
Defined in
Click here to see this topic
lotus.notes.ViewColumn
Click here to see this topic
Data type3
boolean
Syntax
public boolean isHidden()
throws NotesException
Legal values
True
The column is hidden.
False
The column is not hidden.
Click here to see this topic
See examples
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. Indicates if a name is hierarchical.
Defined in
Click here to see this topic
lotus.notes.Name
class
Click here to see this topic
Data type
boolean
Syntax
public boolean isHierarchical()
throws NotesException
Legal values
true if the name is hierarchical
false if the name is not hierarchicalp
Click here to see this topic
See examples
Click here to see this topic
See related topics
Click here to see this topic
Abbreviated property
Click here to see this topic
Click here to see this topic
Canonical property
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. Indicates whether a database represents a multi-database search index.
Defined in
Click here to see this topic
lotus.notes.Database
Click here to see this topic
Data type
booleano
Syntax
public boolean isMultiDbSearch()
throws NotesException
Legal values
True
The database represents a multi-database search index.
Falses
The database does not represent a multi-database search index.
Click here to see this topic
See examples
See related topics
Click here to see this topic
FTSearch method
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-write. Indicates if an item is a Names item. A Names item contains a list of Notes user names.
Defined in
Click here to see this topic
lotus.notes.Item
Click here to see this topic
Data type
boolean
Syntax
public boolean isNames()
throws NotesException
public setNames(boolean flag)
throws NotesException
Legal values
True
The item is a Names item.
Falseh
The item is not a Names item.
Usage
A Names item is stored as text and its Type property returns TEXT. Use IsNames to determine if a text item is also a Names item.
Click here to see this topic
See examples
See related topics
Click here to see this topic
IsAuthors property
Click here to see this topic
Click here to see this topic
IsReaders property
Click here to see this topic
Click here to see this topic
Type property
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. Indicates if a document is new. A document is new if it hasn't been saved.d
Defined in
Click here to see this topic
lotus.notes.Document
Click here to see this topic
Data type
boolean
Syntax
public boolean isNewNote()
throws NotesException
Legal values
True
The document was created, but has not been saved.
False
The document has been saved.
Click here to see this topic
See examples
See related topics
Click here to see this topic
save method
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-Write. For an entry with Author access or above to a database, indicates if an entry can delete documents.
Defined in
Click here to see this topic
lotus.notes.ACLEntry
Click here to see this topic
Data type
boolean
Syntax
public boolean isCanDeleteDocuments()
throws NotesException
public void setCanDeleteDocuments(boolean flag)
throws NotesException
Legal values
True
The entry can delete documents from the database.m
False
The entry cannot delete documents from the database.
Usagep
After setting this property, you must call Save on the parent lotus.notes.ACL in order for the changes to take effect. If you do not call Save, your changes to the lotus.notes.ACLEntry are lost.
Setting this property has no effect on an ACL entry unless the entry has Author access or above to a database. If an entry has Reader, Depositor, or No access, this property is always False.
Click here to see this topic
See examples
See related topics
Click here to see this topic
IsCanCreateDocuments property
Click here to see this topic
Click here to see this topic
IsCanCreatePersonalAgent property
Click here to see this topic
Click here to see this topic
IsCanCreatePersonalFolder property
Click here to see this topic
Click here to see this topic
save method
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-Write. indicates whether an ID file is NorthAmerican. Useful when calling p
Click here to see this topic
RegisterNewUserU
Click here to see this topic
Click here to see this topic
RegisterNewServer
Click here to see this topic
, and
Click here to see this topic
RegisterNewCertifier
Click here to see this topic
Defined in
Click here to see this topic
lotus.notes.Registration class
Click here to see this topic
Data type
boolean
Syntax
public boolean isNorthAmerican()
throws NotesException
public void setNorthAmerican(boolean flag)
throws NotesException
Legal Values
True
Default. The ID file is North American.s
False
The ID file is not North American.
Click here to see this topic
See examples
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. Indicates if the program is running on a server.
Defined in
Click here to see this topic
lotus.notes.Sessionl
Click here to see this topic
Data typet
booleanl
Syntax
public boolean isOnServer()
throws NotesException
Legal values
true if the program is running on a server
false if the program is running on a workstation
Usagea
A program is running on a server if it is an agent in a server-based database, and the agent has one of the following triggers:
When new mail arrivesi
When documents have been created or modified
When documents have been pasted
On schedule hourly, daily, weekly, or monthlyt
All other programs run on a workstation.
Click here to see this topic
See examples
Click here to see this topic
See related topics
Click here to see this topic
Accessing session properties
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. Indicates whether a database is open.
Defined in
Click here to see this topic
lotus.notes.Database
Click here to see this topic
Data type
boolean&
Syntax
public boolean isOpen()
throws NotesExceptione
Legal values
True
The database is open.
FalseF
The database is not open.
Click here to see this topic
See examples
See related topics
Click here to see this topic
getURLDatabase methoda
Click here to see this topic
Click here to see this topic
openDatabase method
Click here to see this topic
Click here to see this topic
openDatabaseByReplicaID method
Click here to see this topic
Click here to see this topic
openDatabaseIfModified method
Click here to see this topic
Click here to see this topic
openMailDatabase method
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. Indicates if a database is a Personal Address Book.
Defined in
Click here to see this topic
lotus.notes.Database
Click here to see this topic
Data typeA
boolean
Syntax
public boolean isPrivateAddressBook()
throws NotesException
Legal values
True
The database is a Personal Address Book.
False
The database is not a Personal Address Book.
Usage
This property is available for lotus.notes.Databases retrieved from the AddressBooks property in lotus.notes.Session. For other lotus.notes.Database objects, this property has no value, and therefore evaluates to False when used in conditional statements.g
Click here to see this topic
See examples
See related topics
Click here to see this topic
AddressBooks property
Click here to see this topic
Click here to see this topic
IsPublicAddressBook property
Click here to see this topic
{z_]s
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. Indicates if a lotus.notes.Document object is a profile document.
Defined in
Click here to see this topic
lotus.notes.Document
Click here to see this topic
Data type
boolean
Syntax
public boolean isProfile()
throws NotesException
Legal values
True
The document is a profile document.r
False
The document is not a profile document.J
Click here to see this topic
See examples
See related topics
Click here to see this topic
getProfileDocument methodR
Click here to see this topic
Click here to see this topic
Key property
Click here to see this topic
Click here to see this topic
NameOfProfile property
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-Write. Indicates if a user needs at least Editor access to modify an item.
Defined in
Click here to see this topic
lotus.notes.Item
Click here to see this topic
Data type
boolean
Syntax
public boolean isProtected()
throws NotesException
public void setProtected(boolean flag)
throws NotesException
Legal values
True
You need at least Editor access to modify the item.e
False
You do not need Editor access to modify the item. You can modify it as long as you have Author access or better.
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. Indicates if a database is a Public Address Book.
Defined in
Click here to see this topic
lotus.notes.Database
Click here to see this topic
Data type
boolean
Syntax
public boolean isPublicAddressBook()
throws NotesException
Legal values
True
The database is a Public Address Book.
False
The database is not a Public Address Book.
UsageP
This property is available for lotus.notes.Databases retrieved from the AddressBooks property in lotus.notes.Session. For other lotus.notes.Database objects, this property has no value, and therefore evaluates to false when used in conditional statements.h
Click here to see this topic
See examples
See related topics
Click here to see this topic
AddressBooks property
Click here to see this topic
Click here to see this topic
IsPrivateAddressBook property
Click here to see this topic
{z_]s
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-write. Indicates if the current entry is a public reader of the database.
Defined in
Click here to see this topic
lotus.notes.ACLEntry class
Click here to see this topic
Data type
boolean
Syntax
public boolean isPublicReader()
throws NotesExceptionD
public void setPublicReader(boolean flag)
throws NotesException
Legal values
True
The current entry is a public reader.
False
The current entry is not a public reader.
Usage
This property is False by default.
See related topics
Click here to see this topic
IsPublicWriter property
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-write. Indicates if the current entry is a public writer of the database.
Defined in
Click here to see this topic
lotus.notes.ACLEntry class
Click here to see this topic
Data type
boolean
Syntax
public boolean isPublicWriter()
throws NotesException
public void setPublicWriter(boolean flag)
throws NotesExceptionh
Legal values
True
The current entry is a public writer.s
False
The current entry is not a public writer.
Usagew
This property is False by default.
See related topics
Click here to see this topic
IsPublicReader propertyA
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. Indicates if an agent is public or personal.s
A public agent is accessible to all users of a database and is stored in the database.
A personal agent is accessible only to its owner and is stored in the owner's desktop file.
Defined in
Click here to see this topic
lotus.notes.Agente
Click here to see this topic
Data type0
boolean
Syntax
public boolean isPublic()
throws NotesExceptiont
Legal values
true if the agent is publicP
false if the agent is personal
Click here to see this topic
See examples
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-Write. Indicates whether an item is of type Readers. A Readers item contains a list of Notes user names, indicating people who have Reader access to a particular document.
Defined in
Click here to see this topic
lotus.notes.Item
Click here to see this topic
Data typey
booleane
Syntax
public boolean isReaders()
throws NotesException
public void setReaders(boolean flag)
throws NotesException
Legal values
True
The item is of type Readers.
False
The item is not of type Readers.
Usage
A Readers item is stored as text and its Type property returns TEXT. Use IsReaders to determine if a text item is also a Readers item.
Click here to see this topic
See examples
See related topics
Click here to see this topic
IsAuthors property
Click here to see this topic
Click here to see this topic
IsNames property
Click here to see this topic
Click here to see this topic
Type property
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. Indicates if a column contains only response documents.
Defined in
Click here to see this topic
lotus.notes.ViewColumn
Click here to see this topic
Data typek
boolean
Syntax
public boolean isResponse()
throws NotesException@
Legal values
True
The column contains only response documents.
False
The column contains any kind of document.a
Click here to see this topic
See examples
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. Indicates if a document is a response to another document.V
Defined in
Click here to see this topic
lotus.notes.Document
Click here to see this topic
Data typeE
boolean
Syntax
public boolean isResponse()
throws NotesException
Legal values
True
The document is a response to another document.
Falsel
The document is not a response to another document.
Click here to see this topic
See examples
See related topics
Click here to see this topic
getChild method
Click here to see this topic
Click here to see this topic
getParentDocument method
Click here to see this topic
Click here to see this topic
makeResponse method
Click here to see this topic
Click here to see this topic
ParentDocumentUNID propertyl
Click here to see this topic
Click here to see this topic
Responses property
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Given a role, indicates if the role is enabled for an entry.
Defined in
Click here to see this topic
lotus.notes.ACLEntry
Click here to see this topic
Syntax
public boolean isRoleEnabled(String role)
throws NotesException
Parameter_
String role
The name of the role.
Return value
booleane
True
The role is enabled for this entry.
False
The role is not enabled.
Usage
If the role does not exist in the ACL, Notes throws the exception: "Role name not found."
Click here to see this topic
See examples
See related topics
Click here to see this topic
addRole method
Click here to see this topic
Click here to see this topic
deleteRole methodi
Click here to see this topic
Click here to see this topic
disableRole method
Click here to see this topic
Click here to see this topic
enableRole method
Click here to see this topic
Click here to see this topic
Roles property
Click here to see this topic
Click here to see this topic
Roles property
Click here to see this topic
&6EJ6
Jz aos
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. Indicates if a document contains a signature.
Defined in
Click here to see this topic
lotus.notes.Document
Click here to see this topic
Data type
boolean
Syntax
public boolean isSigned()
throws NotesException
Legal values
True
The document contains one or more signatures.e
False
The document does not contain signatures.
Usage
To access the signatures, you must find the items of type SIGNATURE in the document.
Click here to see this topic
See examples
See related topics
Click here to see this topic
IsSignOnSend property
Click here to see this topic
Click here to see this topic
sign method
Click here to see this topic
Click here to see this topic
Signer property
Click here to see this topic
Click here to see this topic
Type propertyv
Click here to see this topic
Click here to see this topic
Verifier propertyr
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-Write. Indicates if an item contains a signature.
Defined in
Click here to see this topic
lotus.notes.Item
Click here to see this topic
Data typed
booleand
Syntax
public boolean isSigned()
throws NotesException
public void setSigned(boolean flag)
throws NotesExceptiont
Legal values
True
The item is signed.E
Falsel
The item is not signed.
See related topics
Click here to see this topic
IsEncrypted property
Click here to see this topic
Click here to see this topic
IsProtected property
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. Indicates if the documents in a collection are sorted. A collection is sorted only when it results from a full text search of a database.
Defined in
Click here to see this topic
lotus.notes.DocumentCollection
Click here to see this topic
Data typet
booleand
Syntax
public boolean isSorted()
throws NotesExceptiont
Legal values
True
The documents in the collection are sorted
False
The documents in the collection are not sorted
Usage
When a collection is sorted, the documents are sorted by relevance score with the most-relevant document appearing first. A relevance score is a number that Notes assigns to each document that matches a particular full text search query. The number is related to the number of matches that were found in the document.
Click here to see this topic
See examples
See related topics
Click here to see this topic
FTSearch method
Click here to see this topic
Click here to see this topic
FTSearchScore property
Click here to see this topic
Click here to see this topic
unprocessedFTSearch method
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. Indicates if a column is sorted.i
Defined in
Click here to see this topic
lotus.notes.ViewColumn
Click here to see this topic
Data type
boolean
Syntax
public boolean isSorted()
throws NotesException
Legal values
True
The column is sorted.c
Falsec
The column is not sorted.
Usage
If the user can sort the column in the user interface by clicking its heading, but the column is not otherwise sorted, this property returns False.
Click here to see this topic
See examples
See related topics
Click here to see this topic
IsCategory propertyi
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. Indicates if form is a subform.
Defined in
Click here to see this topic
lotus.notes.Form
Click here to see this topic
Data type
boolean
Syntax
public boolean isSubForm()
throws NotesException
Legal values
True
The document is a subform.
False
The document is not a subform.
Click here to see this topic
See examples
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-Write. Indicates if an item can appear in a view or folder.
Defined in
Click here to see this topic
lotus.notes.Item
Click here to see this topic
Data type
boolean
Syntax
public boolean isSummary()
throws NotesException
public void getSummary(boolean flag)
throws NotesException
Legal values
True
The item is a summary.
False
The item is not a summary.
Usage
Rich text cannot appear in a view, so the IsSummary property for a lotus.notes.RichTextItem always returns False.
When you create a new item using New, the IsSummary property for the item defaults to False.
When you create a new item using the AppendItemValue method in lotus.notes.Document, or the extended class syntax, the IsSummary property for the item defaults to True.
Click here to see this topic
See examples
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. Indicates if the time format is 24-hour.
Defined in
Click here to see this topic
lotus.notes.International Class
Click here to see this topic
Data type
boolean
Syntax
public boolean isTime24Hour()
throws NotesException
Legal values
True if the time format is 24-hour.e
False if the time format is 12-hour.
Click here to see this topic
See examples
Click here to see this topic
See related topics
Click here to see this topic
Accessing international settings
Click here to see this topic
Click here to see this topic
AMString property
Click here to see this topic
Click here to see this topic
PMString property
Click here to see this topic
Click here to see this topic
TimeSep property
Click here to see this topic
Click here to see this topic
TimeZone property
Click here to see this topic
}%ALh:ts
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-Write. Italic rich text attribute.
Defined in
Click here to see this topic
lotus.notes.
RichTextStyle
Click here to see this topic
Data type
Syntax
public int getItalic()
throws NotesException
public void setItalic(int value)
throws NotesException
Legal values
YES for italic
NO for non-italic
STYLE_NO_CHANGE to maintain the previous state
Click here to see this topic
See examples
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. The name of the item whose value is shown in the column. For columns whose values are simple functions or formulas, returns an automatically generated internal name.
Defined in
Click here to see this topic
lotus.notes.ViewColumn
Click here to see this topic
Data typet
Object of type java.lang.Stringl
Syntax
public String getItemName()
throws NotesException
Usagei
This property is useful with columns that display a field value. It's not so useful with columns that display the result of a simple function or formula.
Click here to see this topic
See examples
See related topics
Click here to see this topic
Formula property
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. All the items on a document. An item is any piece of data stored in a document.
Defined in
Click here to see this topic
lotus.notes.Document
Click here to see this topic
Data type
Object of type java.util.Vector whose elements are of type
Click here to see this topic
lotus.notes.Item
Click here to see this topic
Syntax
public java.util.Vector getItems()
throws NotesException
Click here to see this topic
See examples
See related topics
Click here to see this topic
appendItemValue method
Click here to see this topic
Click here to see this topic
getFirstItem methode
Click here to see this topic
Click here to see this topic
getItemValue methodn
Click here to see this topic
Click here to see this topic
hasItem method
Click here to see this topic
Click here to see this topic
lotus.notes.Item class
Click here to see this topic
Click here to see this topic
replaceItemValue methoda
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. The following components of a hierarchical name in the order shown separated by backslashes: country\organization\organizational unit 1\.organizational unit 2\.organizational unit 3\.organizational unit 4. Returns null if the property is undefined
Defined in
Click here to see this topic
lotus.notes.Name
class
Click here to see this topic
Data type
String
Syntax
public String getKeyword()
throws NotesException
Click here to see this topic
See examples
Click here to see this topic
See related topics
Click here to see this topic
Country property
Click here to see this topic
Click here to see this topic
Organization propertyJ
Click here to see this topic
Click here to see this topic
OrgUnit1 property
Click here to see this topic
Click here to see this topic
OrgUnit2 property
Click here to see this topic
Click here to see this topic
OrgUnit3 property
Click here to see this topic
Click here to see this topic
OrgUnit4 property
Click here to see this topic
V\W4s
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. If a profile document, the user name (key) of the profile.
Defined in
Click here to see this topic
lotus.notes.Document
Click here to see this topic
Data type
Object of type java.lang.String
Syntax
public String getKey()
throws NotesException
Click here to see this topic
See examples
See related topics
Click here to see this topic
getProfileDocument method
Click here to see this topic
Click here to see this topic
IsProfile property
Click here to see this topic
Click here to see this topic
NameOfProfile property
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. The date a document was last modified or read.
Defined in
Click here to see this topic
lotus.notes.Document
Click here to see this topic
Data type
Object of type java.lang.Vector whose elements are objects of type
Click here to see this topic
lotus.notes.DateTime
Click here to see this topic
Syntax
public lotus.notes.DateTime getLastAccessed()
throws NotesExceptionh
Click here to see this topic
See examples
See related topics
Click here to see this topic
Created property
Click here to see this topic
Click here to see this topic
LastModified property
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. The exit status code returned by the Agent Manager the last time the current agent ran.
Defined in
Click here to see this topic
lotus.notes.AgentContext
Click here to see this topic
Data typeo
intL
Syntax
public int getLastExitStatus()
throws NotesException
Usage
This property returns 0 if the agent ran without errors.
Click here to see this topic
See examples
Click here to see this topic
See related topics
Click here to see this topic
LastRun property
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. The date that a database's full text index was last updated.v
Defined in
Click here to see this topic
lotus.notes.Database
Click here to see this topic
Data type
Object of type lotus.notes.DateTime\
Syntax
public lotus.notes.DateTime getLastFTIndexed()
throws NotesException
UsageG
If the database does not have a full text index, this property returns null.
Click here to see this topic
See examples
See related topics
Click here to see this topic
FTSearch method
Click here to see this topic
Click here to see this topic
FTSearch method
Click here to see this topic
Click here to see this topic
FTSearchScore property
Click here to see this topic
Click here to see this topic
IsFTIndexed property
Click here to see this topic
Click here to see this topic
unprocessedFTSearch method
Click here to see this topic
Click here to see this topic
updateFTIndex method
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. The date that a database was last modified.
Defined in
Click here to see this topic
lotus.notes.Database
Click here to see this topic
Data type
Object of type
Click here to see this topic
lotus.notes.DateTime
Click here to see this topic
Syntax
public lotus.notes.DateTime getLastModified()
throws NotesExceptiono
Click here to see this topic
See examples
See related topics
Click here to see this topic
openDatabaseIfModified methodt
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. The date a document was last modified.
Defined in
Click here to see this topic
lotus.notes.Document
Click here to see this topic
Data type
Object of type java.lang.Vector whose elements are objects of type
Click here to see this topic
lotus.notes.DateTime
Click here to see this topic
Syntax
public lotus.notes.DateTime getLastModified()
throws NotesException
Click here to see this topic
See examples
See related topics
Click here to see this topic
Created property
Click here to see this topic
Click here to see this topic
LastAccessed propertyi
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. The date that an item was last modified.
Defined in
Click here to see this topic
lotus.notes.Item
Click here to see this topic
Data typen
Click here to see this topic
lotus.notes.DateTime
Click here to see this topic
Syntax
public lotus.notes.DateTime getLastModified()
throws NotesException
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. The date that a view was last modified.
Defined in
Click here to see this topic
lotus.notes.View
Click here to see this topic
Data typei
Click here to see this topic
lotus.notes.DateTime
Click here to see this topic
Syntax
public lotus.notes.DateTime getLastModified()
throws NotesExceptionu
Click here to see this topic
See examples
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. The date that an agent last ran.a
Defined in
Click here to see this topic
lotus.notes.Agents
Click here to see this topic
Data type
Click here to see this topic
lotus.notes.DateTime
Click here to see this topic
Syntax
public lotus.notes.DateTime getLastRun()
throws NotesException
Usage
If the script has never been run before, this property returns null.
Click here to see this topic
See examples
Click here to see this topic
See related topics
Click here to see this topic
LastExitStatus property
Click here to see this topic
Click here to see this topic
LastRun property
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. The date when the current agent was last executed.
Defined in
Click here to see this topic
lotus.notes.AgentContext
Click here to see this topic
Data type
Click here to see this topic
lotus.notes.DateTime
Click here to see this topic
Syntax
public lotus.notes.DateTime getLastRun()
throws NotesException
UsageF
If the script has never been run before, this property returns null.
Click here to see this topic
See examples
Click here to see this topic
See related topics
Click here to see this topic
LastExitStatus property
Click here to see this topic
Click here to see this topic
LastRun property
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-Write. The access level this entry has for this database.
Defined in
Click here to see this topic
lotus.notes.ACLEntry
Click here to see this topic
Data type
inte
Syntax
public int getLevel()
throws NotesException
public void setLevel(int level)
throws NotesExceptiono
Legal values
These are defined in lotus.notes.Database.
ACLLEVEL_NOACCESS
No access
ACLLEVEL_DEPOSITOR
Depositor access
ACLLEVEL_READER
Reader access
ACLLEVEL_AUTHOR
Author access
ACLLEVEL_EDITOR
Editor access
ACLLEVEL_DESIGNERt
Designer access
ACLLEVEL_MANAGER
Manager access
Click here to see this topic
See examples
See related topics
Click here to see this topic
CurrentAccessLevel property
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-Write. A string representing a date-time, in the local time zone. Additional methods let you set the local time with integer and boolean values.
Defined in
Click here to see this topic
lotus.notes.DateTime
Click here to see this topic
Data types
String
Syntax
public String getLocalTime()
throws NotesException
public void setLocalTime(String t)
throws NotesException
public void setLocalDate(int year, int month, int day, boolean dst)
throws NotesException
public void setLocalTime(int hour, int minute, int second, int hundredths)
throws NotesException
Usage
When you set this property, it changes the value of the date-time that the object represents, and, therefore, affects the GMTTime property.
Click here to see this topic
See examples
Click here to see this topic
See related topics
Click here to see this topic
Working with Notes time
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-Write. Indicates if action logging is enabled or not.
Defined in
Click here to see this topic
lotus.notes.Log
Click here to see this topic
Data type
boolean
Syntax
public boolean isLogActions()
throws NotesException
public void setLogActions(boolean flag)
throws NotesExceptiont
Return Values
true (default) enables action logging
false disables action loggingv
UsageP
The logAction method has no effect while the logActions property is false.
Click here to see this topic
See examples
Click here to see this topic
See related topics
Click here to see this topic
logAction method
Click here to see this topic
Click here to see this topic
NumActions property
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Records an action in a log.v
Defined in
Click here to see this topic
lotus.notes.Logi
Click here to see this topic
Syntax
public void logAction(String action)
throws NotesException
Parameter
String actiont
A description of the action, as you want it to appear in the log.
Usage
The behavior of this method depends upon the type of log you open.
If you open a Notes database using t
Click here to see this topic
openNotesLog
Click here to see this topic
, this method creates a new document in the database. The A$ACTION item in the document contains the description
If you open a mail memo using
Click here to see this topic
openMailLog
Click here to see this topic
, this method adds the description to the Body item of the memo, along with the current date and time.
If you open a file using
Click here to see this topic
openFileLogt
Click here to see this topic
, this method adds the description to the next line of the file, along with the log's ProgramName and the current date and time.
Click here to see this topic
See examples
Click here to see this topic
See related topics
Click here to see this topic
IsLogActions property
Click here to see this topic
Click here to see this topic
Making a Notes log
Click here to see this topic
Click here to see this topic
NumActions property
Click here to see this topic
Click here to see this topic
openFileLog method
Click here to see this topic
Click here to see this topic
openMailLog method
Click here to see this topic
Click here to see this topic
openNotesLog methodI
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-Write. Indicates if error logging is enabled or not.
Defined in
Click here to see this topic
lotus.notes.Log
Click here to see this topic
Data type
boolean
Syntax
public boolean isLogErrors()
throws NotesException
public void setLogErrors(boolean flag)
throws NotesException
Return Values
true (default) enables error logging
false disables error logging
Usage
The logError method has no effect while the LogErrors property is false.
Click here to see this topic
See examples
Click here to see this topic
See related topics
Click here to see this topic
logError methodE
Click here to see this topic
Click here to see this topic
NumErrors property
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Records an error in a log.
Defined in
Click here to see this topic
lotus.notes.Log
Click here to see this topic
Syntax
public void logError(int code, String text)
throws NotesException
Parameters
int code
A number indicating which error occurred.l
String text
A description of the error that occurred, as you want it to appear in the log.
UsageL
The behavior of this method depends upon the type of log you open.
If you open a Notes database using n
Click here to see this topic
openNotesLog
Click here to see this topic
, this method creates a new document in the database. The A$ERRCODE item in the document contains the code and the A$ERRMSG item contains the description
If you open a mail memo using
Click here to see this topic
openMailLog
Click here to see this topic
, this method adds the code and the description to the Body item of the memo, along with the current date and time.v
If you open a file using
Click here to see this topic
openFileLog
Click here to see this topic
, this method adds the code and the description to the next line of the file, along with the log's ProgramName and the current date and time.
Name property\in lotus.notes.ACLEntrygetName method\in lotus.notes.ACLEntrysetName method\in lotus.notes.ACLEntryProgAllH_NAME_PROPERTY_ACLENTRY_JAVAContext Help FormName property
Name property\in lotus.notes.EmbeddedObjectgetName method\in lotus.notes.EmbeddedObjectProgAllH_NAME_PROPERTY_OBJECT_JAVAContext Help FormName property
lotus.notes.DocumentCollection classDocumentCollection classProgAllH_NOTESDOCUMENTCOLLECTION_CLASS_JAVAContext Help Formlotus.notes.DocumentCollection class
lotus.notes.TextStyle classRichTextStyle classStyles\rich textAttributes\rich textRich text\attributesProgAllH_NOTESRICHTEXTSTYLE_CLASS_JAVAContext Help Formlotus.notes.RichTextStyle class
Sends a Notes event out to the network. Only scripts running on a server can use this method.
Defined in
Click here to see this topic
lotus.notes.Log
Click here to see this topic
Syntax
public void logEvent(String text, String queue, int event, int severity)
throws NotesException
Parameters
String text
The message to send to the network.
String queue
The name of the queue. Notes picks a queue if you send an empty string ("").
int event
Indicates the kind of event being logged. May be any of the following:
lotus.notes.Log.EV_ALARM
lotus.notes.Log.EV_COMM
lotus.notes.Log.EV_MAIL
lotus.notes.Log.EV_MISC
lotus.notes.Log.EV_REPLICA
lotus.notes.Log.EV_RESOURCE
lotus.notes.Log.EV_SECURITY
lotus.notes.Log.EV_SERVER
lotus.notes.Log.EV_UNKNOWN
lotus.notes.Log.EV_UPDATE
int severity
Indicates the severity of the event being logged. May be any of the following:
lotus.notes.Log.SEV_FAILUREo
lotus.notes.Log.SEV_FATAL
lotus.notes.Log.SEV_NORMAL
lotus.notes.Log.SEV_WARNING1
lotus.notes.Log.SEV_WARNING2
lotus.notes.Log.SEV_UNKNOWN
Usage
This method does not affect other open logs (database, file, or mail). Using the logAction or logError method has no effect on event logging.
See related topics
Click here to see this topic
IsOnServer propertys
Click here to see this topic
Click here to see this topic
logAction method
Click here to see this topic
Click here to see this topic
logError methodd
Click here to see this topic
Click here to see this topic
Making a Notes log
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Makes one document a response to another document. The two documents must be in the same database.
Defined in
Click here to see this topic
lotus.notes.Document
Click here to see this topic
Syntax
public void makeResponse(lotus.notes.Document doc)
throws NotesException
Parameter
lotus.notes.Document doc
The document to which the current document becomes a response.
Usage
You must call Save after this method if you want to save the change you have made.
Click here to see this topic
See examples
See related topics
Click here to see this topic
IsResponse propertyr
Click here to see this topic
Click here to see this topic
save method
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
The
Click here to see this topic
lotus.notes.Log class
Click here to see this topic
provides these methods for opening a log:
Click here to see this topic
penFileLog
Click here to see this topic
opens a file for logging.
Click here to see this topic
penMailLog
Click here to see this topic
opens a mail memo for logging. The memo is mailed when the log is closed.
Click here to see this topic
penNotesLog
Click here to see this topic
opens a Notes database for logging. Each log entry is a Notes document with the items A$PROGNAME, A$LOGTIME, A$USER, A$LOGTYPE, A$ACTION, A$ERRCODE, and A$ERRMSG. Use the system template alog.ntf to create databases suitable for logging.
Click here to see this topic
penAgentLog
Click here to see this topic
opens an agent log for logging. This method is valid only in an agent. Each agent has an associated log that is accessible through Agent - Log when the agent is selected.
The
Click here to see this topic
close method
Click here to see this topic
closes a log.
These methods make entries in the log:
Click here to see this topic
ogAction
Click here to see this topic
logs an action.
Click here to see this topic
ogErrorO
Click here to see this topic
logs an error.
The
Click here to see this topic
ogEvent
Click here to see this topic
method can be used on servers to generate Notes events on the network, including events that can be seen by the NotesView product.
The following methods access the lotus.notes.Log properties:
Click here to see this topic
isLogActions
Click here to see this topic
returns true if action logging is enabled;
Click here to see this topic
set
LogActions
Click here to see this topic
sets this property to true (default) or false to enable or disable action logging.
Click here to see this topic
isLogError
Click here to see this topic
returns true if error logging is enabled;
Click here to see this topic
set
LogError
Click here to see this topic
sets this property to true (default) or false to enable or disable error logging.
Click here to see this topic
isOverwriteFile
Click here to see this topic
returns true if existing files are written over rather than appended to;
Click here to see this topic
set
OverwriteFile
Click here to see this topic
sets this property to true or false (default) to enable or disable file overwriting.
Click here to see this topic
getN
umActions
Click here to see this topic
returns an int value containing the number of actions logged so far.
Click here to see this topic
getN
umErrord
Click here to see this topic
returns an int value containing the number of errors logged so far.
Click here to see this topic
getP
rogramName
Click here to see this topic
returns a String value containing the name of the script to which the entries apply;
Click here to see this topic
etP
rogramName
Click here to see this topic
sets this property.
Click here to see this topic
See examples
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
A newsletter is a summary document containing a picture of another document or links to other documents. Use the s
Click here to see this topic
createNewsletter method
Click here to see this topic
of lotus.notes.Session to create a lotus.notes.Newsletter object based on a document collection. Use one of the following methods to format the newsletter:
Click here to see this topic
ormatDocument
Click here to see this topic
formats the newsletter to contain a picture of one document in the document collection that is the basis for the newsletter. You must iterate through the document collection to
Click here to see this topic
ormatMsgWithDoclinks
Click here to see this topic
formats the newsletter to contain links to all the documents in the document collection that is the basis for the newsletter.
You can use the
Click here to see this topic
end method
Click here to see this topic
of lotus.notes.Document to mail documents based on newsletters.
You can use the
Click here to see this topic
save
method
Click here to see this topic
of lotus.notes.Document to save documents based on newsletters.
The following methods access the lotus.notes.Newsletter properties. These properties are useful only with
Click here to see this topic
for
matMsgWithDoclinks
Click here to see this topic
Click here to see this topic
isDoScore
Click here to see this topic
returns true if the formatted newsletter is to contain each document's relevance score; set this property to true or false with
Click here to see this topic
set
DoScore
Click here to see this topic
before calling formatMsgWithDoclinks.
Click here to see this topic
isDoSubject
Click here to see this topic
returns true if the formatted newsletter is to contain the content of each document's subject field; set this property to true or false (default) with
Click here to see this topic
set
DoSubject
Click here to see this topic
before calling formatMsgWithDoclinks.
Click here to see this topic
getSubjectItemName
Click here to see this topic
returns the name of the field associated with isDoSubject; set this property with t
Click here to see this topic
etSubjectItemNamec
Click here to see this topic
if you set setDoSubject to true.
Click here to see this topic
See examples
Click here to see this topic
1l8ps
1l8ps
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. People, servers, and groups that have Manager access to a database.
Defined in
Click here to see this topic
lotus.notes.Database
Click here to see this topic
Data typey
Object of type java.util.Vector whose elements are of type java.lang.Stringl
Syntax
public java.util.Vector getManagers()
throws NotesException
Usage
Each element in the array is the name of a person, server, or group who has Manager access to the database.
Click here to see this topic
See examples
See related topics
Click here to see this topic
CurrentAccessLevel property
Click here to see this topic
Click here to see this topic
grantAccess method
Click here to see this topic
Click here to see this topic
lotus.notes.ACL classe
Click here to see this topic
Click here to see this topic
lotus.notes.ACLEntry class
Click here to see this topic
Click here to see this topic
queryAccess method
Click here to see this topic
Click here to see this topic
revokeAccess method
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-Write. The minimum number of characters required for a password in an ID file when calling
Click here to see this topic
egisterNewUser
Click here to see this topic
Click here to see this topic
egisterNewServer
Click here to see this topic
, and
Click here to see this topic
egisterNewCertifier
Click here to see this topic
Defined in
Click here to see this topic
lotus.notes.Registration class
Click here to see this topic
Data type
Syntax
public int getMinPasswordLength()
throws NotesException
public void setMinPasswordLength(int len)
throws NotesException
Click here to see this topic
See examples
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-Write. The name of an entry.
Defined in
Click here to see this topic
lotus.notes.ACLEntry
Click here to see this topic
Data type
Click here to see this topic
lotus.notes.Name
Click here to see this topic
Syntax
public lotus.notes.Name getNameObject()
throws NotesExceptionm
public void setNameObject(lotus.notes.Name name)
throws NotesException
Usage
If you change the name of an entry, the other attributes of the entry (such as Level) are preserved.
Click here to see this topic
See examples
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. If a profile document, the name of the profile.
Defined in
Click here to see this topic
lotus.notes.Document
Click here to see this topic
Data type
Object of type java.lang.String
Syntax
public String getNameOfProfile()
throws NotesException
Click here to see this topic
See examples
See related topics
Click here to see this topic
getProfileDocument methoda
Click here to see this topic
Click here to see this topic
IsProfile property
Click here to see this topic
Click here to see this topic
Key property
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-Write. The name of an entry.
Defined in
Click here to see this topic
lotus.notes.ACLEntry
Click here to see this topic
Data type
Object of type java.lang.String
Syntax
public String getName()
throws NotesException
public void setName(String name)
throws NotesException
Usage
If you change the name of an entry, the other attributes of the entry (such as Level) are preserved.
Click here to see this topic
See examples
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. The name of an agent. Within a database, the name of an agent may not be unique.
Defined in
Click here to see this topic
lotus.notes.Agent
Click here to see this topic
Data type
String
Syntax
public String getName()
throws NotesException
Click here to see this topic
See examples
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. The name of the server whose database directory you are searching.
Defined in
Click here to see this topic
lotus.notes.DbDirectoryA
Click here to see this topic
Data type
Object of type java.lang.StringA
Syntax
public String getName()
throws NotesException
Usageu
This property returns an empty string ("") for lotus.notes.DbDirectory objects that represent the current computer.o
Click here to see this topic
See examples
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. The name of a form.
Defined in
Click here to see this topic
lotus.notes.Form
Click here to see this topic
Data type
Object of type java.lang.String,
Syntax
public String getName()
throws NotesExceptiona
Usages
This property returns the first name associated with a form. Use the Aliases property to return any additional names.
Click here to see this topic
See examples
See related topics
Click here to see this topic
Aliases property
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. The name of an item.
Defined in
Click here to see this topic
lotus.notes.Item
Click here to see this topic
Data type
Object of type java.lang.Stringc
Syntax
public String getName()
throws NotesExceptionu
Usage
There may be multiple items on a document with the same name.
All file attachments have the name $FILE.
Click here to see this topic
See examples
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. The name used to reference an embedded object or object link.
Defined in
Click here to see this topic
lotus.notes.EmbeddedObject
Click here to see this topic
Data type
Object of type java.lang.String
Syntax
public String getName()
throws NotesExceptiont
Usage
For file attachments, this property returns null. If the embedded object or object link does not have a name, this property returns null.
If the embedded object or object link was created using the EmbedObject method in lotus.notes.RichTextItem, this property returns the
name
parameter that was used with EmbedObject.
If the embedded object or object link was created using the Notes user interface, this property returns the name of the object as it appears in the InfoBox.
Click here to see this topic
See examples
See related topics
Click here to see this topic
embedObject method
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. The name of a view.
Defined in
Click here to see this topic
lotus.notes.View
Click here to see this topic
Data type
Object of type java.lang.String
Syntax
public String getName()
throws NotesException
Usage
You can use GetView with any of the view's names. Notes parses through all the view's names and the Name property returns the first one on the list. You can use the Aliases property to access the rest of the names.
For example, for the name "All\By review date|Review," the property returns "All\By review date."
Click here to see this topic
See examples
See related topics
Click here to see this topic
Aliases property
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. The NoteID of a document, which is an 8-character hexadecimal value that uniquely identifies a document within a particular database.
Defined in
Click here to see this topic
lotus.notes.Document
Click here to see this topic
Data type
Object of type java.lang.String
Syntax
public String getNoteID()
throws NotesException
Usage
A typical Note ID looks like this: 000020FA. A NoteID represents the location of a document within a specific database file, so documents which are replicas of one another generally have different NoteIDs. A NoteID does not change, unless the document is deleted.
Click here to see this topic
See examples
See related topics
Click here to see this topic
getDocumentByID method
Click here to see this topic
Click here to see this topic
ParentDocumentUNID property
Click here to see this topic
Click here to see this topic
UniversalID property
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Represents a single entry in an access control list. An entry may be for a person, a group, or a server.
Syntax
public class lotus.notes.ACLEntry extends NotesBase
Containment
Contained by:
Click here to see this topic
lotus.notes.ACL
Click here to see this topic
Properties
Click here to see this topic
IsCanCreateDocuments
Click here to see this topic
through isCanCreateDocuments and setCanCreateDocumentsd
Click here to see this topic
IsCanCreatePersonalAgent
Click here to see this topic
through isCanCreatePersonalAgent and setCanCreatePersonalAgent
Click here to see this topic
IsCanCreatePersonalFolderd
Click here to see this topic
through isCanCreatePersonalFolder and setCanCreatePersonalFolder
Click here to see this topic
IsCanDeleteDocuments
Click here to see this topic
through isCanDeleteDocuments and setCanDeleteDocuments
Click here to see this topic
sPublicReader
Click here to see this topic
through isPublicReader and setPublicReader
Click here to see this topic
sPublicWriter
Click here to see this topic
through isPublicWriter and setPublicWriter
Click here to see this topic
Levelp
Click here to see this topic
through getLevel and setLevel
Click here to see this topic
Name
Click here to see this topic
through getName and setName
Click here to see this topic
NameObject
Click here to see this topic
through getNameObject
Click here to see this topic
Parent
Click here to see this topic
through getParent
Click here to see this topic
Roles
Click here to see this topic
through getRoles
Methods
Click here to see this topic
isableRole
Click here to see this topic
Click here to see this topic
nableRole
Click here to see this topic
Click here to see this topic
sRoleEnabled
Click here to see this topic
Click here to see this topic
emove
Click here to see this topic
Creation
To create a new lotus.notes.ACLEntry object, use s
Click here to see this topic
reateACLEntry
Click here to see this topic
in lotus.notes.ACL.
You must call the
Click here to see this topic
ave method
Click here to see this topic
on the ACL if you want the modified ACL to be saved to disk.2
Access
lotus.notes.ACL provides three ways to access an existing lotus.notes.ACLEntry.
To access an entry in an ACL when you know its name, use m
Click here to see this topic
etEntry
Click here to see this topic
To access the first entry in the ACL, use
Click here to see this topic
etFirstEntry
Click here to see this topic
To access entries after the first one, use
Click here to see this topic
etNextEntry
Click here to see this topic
Click here to see this topic
See examples
See related topics
Click here to see this topic
Compiling and running a Java program
Click here to see this topic
Click here to see this topic
createACLEntry methode
Click here to see this topic
Click here to see this topic
lotus.notes.ACL class0
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Represents the access control list (ACL) of a database.
Syntax
public class lotus.notes.ACL extends NotesBase
Containment
Contained by:
Click here to see this topic
lotus.notes.Database
Click here to see this topic
Contains:
Click here to see this topic
lotus.notes.ACLEntry
Click here to see this topic
Properties
Click here to see this topic
IsUniformAccess
Click here to see this topic
through isUniformAccess and setUniformAccess=
Click here to see this topic
Parent
Click here to see this topic
through getParent
Click here to see this topic
Roles
Click here to see this topic
through getRoles
Methodsi
Click here to see this topic
addRole
Click here to see this topic
Click here to see this topic
createACLEntry
Click here to see this topic
Click here to see this topic
deleteRole
Click here to see this topic
Click here to see this topic
getEntry
Click here to see this topic
Click here to see this topic
getFirstEntry
Click here to see this topic
Click here to see this topic
getNextEntry
Click here to see this topic
Click here to see this topic
renameRole
Click here to see this topic
Click here to see this topic
save
Click here to see this topic
Access
Every lotus.notes.Database object contains a lotus.notes.ACL object representing that database's access control list. To get it, use h
Click here to see this topic
ACLh
Click here to see this topic
in lotus.notes.Database.
Usageg
For convenience, the lotus.notes.Database class has three methods you can use to access and modify an ACL without declaring a lotus.notes.ACL object. All you need to know is the name of the person, server, or group.k
To see what access level a person, server, or group has, use
Click here to see this topic
ueryAccess
Click here to see this topic
To grant access, use
Click here to see this topic
rantAccess
Click here to see this topic
To remove access, use
Click here to see this topic
evokeAccess
Click here to see this topic
Click here to see this topic
See examples
See related topics
Click here to see this topic
Compiling and running a Java program
Click here to see this topic
Click here to see this topic
CurrentAccessLevel property
Click here to see this topic
Click here to see this topic
Managers property
Click here to see this topic
&6EJ6
Jz aos
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Represents the agent environment of the current program, if an agent is running it.s
Syntax
public class lotus.notes.AgentContext extends NotesBase
Containment
Contained by:
Click here to see this topic
lotus.notes.SessionM
Click here to see this topic
Contains:
Click here to see this topic
lotus.notes.Agente
Click here to see this topic
Click here to see this topic
lotus.notes.Databasem
Click here to see this topic
Click here to see this topic
lotus.notes.DateTime
Click here to see this topic
Click here to see this topic
lotus.notes.Document
Click here to see this topic
Click here to see this topic
lotus.notes.DocumentCollection
Click here to see this topic
Click here to see this topic
lotus.notes.Name
Click here to see this topic
Properties
Click here to see this topic
CurrentAgent
Click here to see this topic
through getCurrentAgent
Click here to see this topic
CurrentDatabase
Click here to see this topic
through getCurrentDatabase
Click here to see this topic
DocumentContexti
Click here to see this topic
through getDocumentContextc
Click here to see this topic
EffectiveUserNamet
Click here to see this topic
through getEffectiveUserNames
Click here to see this topic
LastExitStatus
Click here to see this topic
through getLastExitStatus
Click here to see this topic
LastRun
Click here to see this topic
through getLastRun
Click here to see this topic
SavedDatac
Click here to see this topic
through getSavedDatag
Click here to see this topic
UnprocessedDocuments
Click here to see this topic
through getUnprocessedDocuments
Methodse
Click here to see this topic
unprocessedFTSearch
Click here to see this topic
Click here to see this topic
unprocessedSearch
Click here to see this topic
Click here to see this topic
updateProcessedDoc
Click here to see this topic
Creation and accessu
Use
Click here to see this topic
getA
gentContext
Click here to see this topic
in lotus.notes.Session to get the AgentContext object for the current agent.
Click here to see this topic
See examples
See related topics
Click here to see this topic
Accessing Notes agents
Click here to see this topic
Click here to see this topic
Compiling and running a Java program
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Represents an agent. The agent may be public or personal, and may be a Release 3 macro.p
Syntax
public class lotus.notes.Agent extends NotesBase
Containmente
Contained by:
Click here to see this topic
lotus.notes.AgentContext
Click here to see this topic
and n
Click here to see this topic
lotus.notes.Database
Click here to see this topic
Properties
Click here to see this topic
Commento
Click here to see this topic
through getComment
Click here to see this topic
CommonOwner
Click here to see this topic
through getCommonOwnerj
Click here to see this topic
IsEnabled
Click here to see this topic
through isEnabled and setEnabled
Click here to see this topic
IsPublic
Click here to see this topic
through isPublic
Click here to see this topic
LastRun
Click here to see this topic
through getLastRun
Click here to see this topic
Name
Click here to see this topic
through getName
Click here to see this topic
Owner
Click here to see this topic
through getOwner
Click here to see this topic
Parent
Click here to see this topic
through getParent
Click here to see this topic
Query
Click here to see this topic
through getQueryi
Click here to see this topic
ServerName
Click here to see this topic
through getServerName and setServerName
Method
Click here to see this topic
emove
Click here to see this topic
Click here to see this topic
Click here to see this topic
Click here to see this topic
save
Click here to see this topic
Access
There are two ways to access an agent.
To access the agent that's currently running, use
Click here to see this topic
getCurrentAgent
Click here to see this topic
in lotus.notes.AgentContext.
To access all the agents in a database, use
Click here to see this topic
getAgentse
Click here to see this topic
in lotus.notes.Database.p
Click here to see this topic
See examples
Click here to see this topic
See related topics
Click here to see this topic
Accessing Notes agents
Click here to see this topic
Click here to see this topic
Compiling and running a Java program
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-Write. Color rich text attribute as listed below.
Defined in
Click here to see this topic
lotus.notes.
RichTextStyle
Click here to see this topic
Data type
intl
Syntax
public int getColor()
throws NotesExceptionS
public void setColor(int value)
throws NotesException
Legal values
COLOR_BLACKc
COLOR_BLUE
COLOR_CYAN
COLOR_DARK_BLUE
COLOR_DARK_CYANN
COLOR_DARK_GREEN
COLOR_DARK_MAGENTA
COLOR_DARK_RED
COLOR_DARK_YELLOW
COLOR_GRAY
COLOR_GREEN
COLOR_LIGHT_GRAY
COLOR_MAGENTA
COLOR_RED
COLOR_WHITE
COLOR_YELLOW
STYLE_NO_CHANGE to maintain the previous state
Click here to see this topic
See examples
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Represents a Notes database.
Syntax
public class lotus.notes.Database extends NotesBase
Containment
Contained by:
Click here to see this topic
lotus.notes.Session
Click here to see this topic
and
Click here to see this topic
lotus.notes.DbDirectory
Click here to see this topic
Can contain: r
Click here to see this topic
lotus.notes.ACL
Click here to see this topic
Click here to see this topic
lotus.notes.Agent
Click here to see this topic
Click here to see this topic
lotus.notes.DateTime
Click here to see this topic
Click here to see this topic
lotus.notes.Document
Click here to see this topic
Click here to see this topic
lotus.notes.DocumentCollection
Click here to see this topic
Click here to see this topic
lotus.notes.Form
Click here to see this topic
Click here to see this topic
lotus.notes.View
Click here to see this topic
Properties
Click here to see this topic
ACL
Click here to see this topic
through getACL
Click here to see this topic
Agents
Click here to see this topic
through getAgents
Click here to see this topic
AllDocuments
Click here to see this topic
through getAllDocuments
Click here to see this topic
Categories
Click here to see this topic
through getCategories and setCategories
Click here to see this topic
Created
Click here to see this topic
through getCreated
Click here to see this topic
CurrentAccessLevel
Click here to see this topic
through getCurrentAccessLevel
Click here to see this topic
DesignTemplateName
Click here to see this topic
through getDesignTemplateName
Click here to see this topic
FileName
Click here to see this topic
through getFileName
Click here to see this topic
FilePath
Click here to see this topic
through getFilePath
Click here to see this topic
Formse
Click here to see this topic
through getFormst
Click here to see this topic
IsDelayUpdates
Click here to see this topic
through isDelateUpdates and setDelayUpdates
Click here to see this topic
sFTIndexed
Click here to see this topic
through isFTIndexed
Click here to see this topic
sMultiDbSearch
Click here to see this topic
through isMultiDbSearch
Click here to see this topic
IsOpen
Click here to see this topic
through isOpen
Click here to see this topic
sPrivateAddressBook
Click here to see this topic
through isPrivateAddressBooki
Click here to see this topic
sPublicAddressBook
Click here to see this topic
through isPublicAddressBook
Click here to see this topic
LastFTIndexed
Click here to see this topic
through getLastFTIndexedr
Click here to see this topic
LastModified
Click here to see this topic
through getLastModified
Click here to see this topic
Managers
Click here to see this topic
through getManagers
Click here to see this topic
Parent
Click here to see this topic
through getParent
Click here to see this topic
PercentUsedh
Click here to see this topic
through getPercentUsed
Click here to see this topic
ReplicaID7
Click here to see this topic
through getReplicaIDc
Click here to see this topic
Server
Click here to see this topic
through getServer
Click here to see this topic
Size
Click here to see this topic
through getSize
Click here to see this topic
SizeQuota{
Click here to see this topic
through getSizeQuota and setSizeQuota
Click here to see this topic
TemplateName
Click here to see this topic
through getTemplateName
Click here to see this topic
Title
Click here to see this topic
through getTitle and setTitle
Click here to see this topic
Viewst
Click here to see this topic
through getViews
Methods
Click here to see this topic
compact
Click here to see this topic
Click here to see this topic
createCopy
Click here to see this topic
Click here to see this topic
createDocument
Click here to see this topic
Click here to see this topic
createFromTemplate
Click here to see this topic
Click here to see this topic
createReplica
Click here to see this topic
Click here to see this topic
FTSearch
Click here to see this topic
Click here to see this topic
getAgent
Click here to see this topic
Click here to see this topic
getDocumentByID
Click here to see this topic
Click here to see this topic
getDocumentByUNID
Click here to see this topic
Click here to see this topic
getDocumentByURL
Click here to see this topic
Click here to see this topic
getForme
Click here to see this topic
Click here to see this topic
getProfileDocument
Click here to see this topic
Click here to see this topic
getURLHeaderInfo
Click here to see this topic
Click here to see this topic
getView
Click here to see this topic
Click here to see this topic
grantAccess
Click here to see this topic
Click here to see this topic
queryAccess
Click here to see this topic
Click here to see this topic
remove
Click here to see this topic
Click here to see this topic
replicate
Click here to see this topic
Click here to see this topic
revokeAccess
Click here to see this topic
Click here to see this topic
search
Click here to see this topic
Click here to see this topic
updateFTIndex
Click here to see this topic
Creation and access
There are several ways you can use the lotus.notes.Database class to access existing databases and to create new ones.
To access an existing database when you know its server and file name, use e
Click here to see this topic
get
Database
Click here to see this topic
in lotus.notes.Session.
To access an existing database when you know its server and replica ID, use
Click here to see this topic
OpenByReplicaIDM
Click here to see this topic
in lotus.notes.DbDirectory.
To access an existing database when you know its server but
its file name, use the
Click here to see this topic
lotus.notes.DbDirectory class
Click here to see this topic
To access the current user's mail database, use
Click here to see this topic
penMailh
Click here to see this topic
in lotus.notes.DbDirectory.
To open the default Web Navigator database, use
Click here to see this topic
penURLDatabase
Click here to see this topic
in lotus.notes.Session.
To access the available Address books, use c
Click here to see this topic
AddressBooks
Click here to see this topic
in lotus.notes.Session.
To test for the existence of a database with a specific server and file name before accessing it, use
Click here to see this topic
penDatabase
Click here to see this topic
or
Click here to see this topic
penDatabaseIfModifiedl
Click here to see this topic
in lotus.notes.DbDirectory.
To create a new database from an existing database, use
Click here to see this topic
reateCopyt
Click here to see this topic
Click here to see this topic
reateFromTemplateu
Click here to see this topic
, or e
Click here to see this topic
reateReplica
Click here to see this topic
To create a new database from scratch, use e
Click here to see this topic
reate
Click here to see this topic
To access a database when you have a lotus.notes.View, lotus.notes.Document, lotus.notes.DocumentCollection, lotus.notes.ACL, or lotus.notes.Agent from that database, use the appropriate Parent (or ParentDatabase) property.
Usagec
A database must be open before you can use the properties and methods in the corresponding lotus.notes.Database object. In most cases, the class library automatically opens a database for you. But watch out for the following cases:s
Attempting to open a database to which the user does not have access throws an exception. You need at least Reader access to a database in order to open it.
A lotus.notes.Database object retrieved from a lotus.notes.DbDirectory object is closed. The following properties are available on the closed database: FileName, FilePath, LastModified, Parent, ReplicaID, Server, Size, SizeQuota, Title. To access all the properties and methods of a database retrieved from a lotus.notes.DbDirectory object, you must explicitly open the database.
A lotus.notes.Database retrieved from the AddressBooks property in lotus.notes.Session is closed. The following properties are available on the closed database: FileName, FilePath, IsPrivateAddressBook, IsPublicAddressBook, Parent, Server. To access all the properties and methods of a database retrieved from the AddressBooks property, you must explicitly open the database.
Access levels
Notes throws an exception when you attempt to perform an operation for which the user does not have appropriate access. The properties and methods that a script can successfully use on a lotus.notes.Database object are determined by these factors:
The user's access level to the database, as determined by the database access control list. The ACL determines if the user can open a database, add documents to it, remove documents from it, modify the ACL, and so on.d
The user's access level to the server on which the database resides, as determined by the Server document in the Public Address Book.e
Click here to see this topic
See examples
See related topics
Click here to see this topic
Compiling and running a Java program
Click here to see this topic
~3X@?
{z_]s
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Represents a range of dates and times.
Syntax
public class lotus.notes.DateRange extends NotesBase
Containment
Contained by:
Click here to see this topic
lotus.notes.Session
Click here to see this topic
Contains:
Click here to see this topic
lotus.notes.DateTime
Click here to see this topic
Properties
Click here to see this topic
EndDateTime
Click here to see this topic
through getEndDateTime and setEndDateTime
Click here to see this topic
StartDateTime=
Click here to see this topic
through getStartDateTime and setStartDateTime
Click here to see this topic
Text
Click here to see this topic
through getText and setText
Creation
To create a new lotus.notes.DateRange object, use
Click here to see this topic
reateDateRange
Click here to see this topic
in lotus.notes.Session. To initialize the object, you can do one of the following:A
Assign values to the t
Click here to see this topic
reateDateRange
Click here to see this topic
parameters.
Assign to
Click here to see this topic
StartDateTimes
Click here to see this topic
and A
Click here to see this topic
EndDateTimen
Click here to see this topic
lotus.notes.DateTime values.
Assign to
Click here to see this topic
Text
Click here to see this topic
a string value that represents a date range. This consists of two string representations of date-time values separated by a hyphen (for example, "01/01/97 - 01/02/97").o
Usagee
When you assign StartDateTime or EndDateTime, its value replaces the corresponding value in Text, and vice versa.
Click here to see this topic
See examples
Click here to see this topic
See related topics
Click here to see this topic
Compiling and running a Java program
Click here to see this topic
Click here to see this topic
Working with Notes timer
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Represents a date and time.r
Syntax
public class lotus.notes.DateTime extends NotesBase
Containmentm
Contained by:
Click here to see this topic
lotus.notes.DateRange
Click here to see this topic
and
Click here to see this topic
lotus.notes.SessionT
Click here to see this topic
Properties
Click here to see this topic
DateOnly
Click here to see this topic
through getDateOnly
Click here to see this topic
GMTTimel
Click here to see this topic
through getGMTTimea
Click here to see this topic
sDST
Click here to see this topic
through isDST
Click here to see this topic
LocalTimee
Click here to see this topic
through getLocalTime, setLocalTime, and setLocalDate
Click here to see this topic
Time
eOnlyn
Click here to see this topic
through getTimeOnly
Click here to see this topic
TimeZone
Click here to see this topic
through getTimeZone
Click here to see this topic
ZoneTime
Click here to see this topic
through getZoneTime
Methods
Click here to see this topic
djustDay
Click here to see this topic
Click here to see this topic
djustHour
Click here to see this topic
Click here to see this topic
djustMinute
Click here to see this topic
Click here to see this topic
djustMonth
Click here to see this topic
Click here to see this topic
djustSecond
Click here to see this topic
Click here to see this topic
djustYearc
Click here to see this topic
Click here to see this topic
onvertToZone
Click here to see this topic
Click here to see this topic
etAnyDateo
Click here to see this topic
Click here to see this topic
etAnyTimes
Click here to see this topic
Click here to see this topic
etNowe
Click here to see this topic
Click here to see this topic
imeDifference
Click here to see this topic
Creation
To create a new lotus.notes.DateTime object, use
Click here to see this topic
reateDateTimet
Click here to see this topic
in lotus.notes.Session.
Usage
You can specify the parameter to
Click here to see this topic
reateDateTime
Click here to see this topic
in lotus.notes.Session as null or an empty string, then set the date and time with
Click here to see this topic
setLocalTime and setLocalDate
Click here to see this topic
. The
Click here to see this topic
reateDateTime
Click here to see this topic
method takes one string parameter. One form of
Click here to see this topic
setLocalTime
Click here to see this topic
takes one string parameter. Other forms of
Click here to see this topic
setLocalTime and setLocalDater
Click here to see this topic
take multiple integer parameters.
The string form of the date parameter should be a date, followed by a space, followed by a time. You can specify a date without a time, but you cannot specify a time without a date.o
The date component of a string parameter can be in any of the following formats:
MM/DD/YY or MM-DD-YY
For example, "04/16/97" and "04-16-97" both represent April 16, 1997. Use this format to specify a year in the 20th century (MM is 50 or greater) or the 21st century (MM is less than 50).
MM/DD/YYYY or MM-DD-YYYY
For example, "04/16/1997" represents April 16, 1997 and "04/16/2097" represents April 16, 2097. Use this format to specify a year in any century.
MM/DD or MM-DD
For example, "08/18" represents August 18, 1996, if 1996 is the current year. When you use this format, Notes appends the current year.
MM/YY or MM-YY
For example, "08-96" represents August 1, 1996. When you use this format, Notes stores it as the first day of the month. Use this format to specify a year in the 20th century (MM is 50 or greater) or the 21st century (MM is less than 50).i
MM/YYYY or MM-YYYY
For example, "08-2096" represents August 1, 2096. When you use this format, Notes stores it as the first day of the month. Use this format to specify a year in any century.
"Today" or "Yesterday"
The time component of a string parameter can be in any of the following formats. The seconds component, SS, is optional in all three:d
HH:MM:SS PM. For example, "09:12:33 PM."
HH:MM:SS AM. For example, "09:12:33 AM."
HH:MM:SS. For example, "09:12:33." If you do not specify AM or PM, the time is treated as a military time; therefore "09:12:33" is stored as 09:12:33 AM, while "21:12:33" is stored as 09:12:33 PM.
Invalid DateTime objects
To test for an invalid DateTime object, compare the result of getLocalTime with null.
Time zones
When you create a new lotus.notes.DateTime object, its TimeZone property is determined by the time zone setting in Notes. For example, if the script runs on a computer whose Notes time zone is set to Eastern Standard Time, the TimeZone property of any new lotus.notes.DateTime object is automatically set to 5. The GMTTime is also determined by the time zone setting.e
Today and Yesterday
When you create a new lotus.notes.DateTime object using an expression such as "Today" or "Yesterday," the value of the date is determined using the current date setting in Notes. These expressions have no effect on the time component of a lotus.notes.DateTime object. To set a lotus.notes.DateTime to the current date
and
time, use
Click here to see this topic
etNowe
Click here to see this topic
Access
To access a date-time value stored in an item on a Notes document, use e
Click here to see this topic
getDateTimeValue
Click here to see this topic
in lotus.notes.Item.
Click here to see this topic
See examples
Click here to see this topic
See related topics
Click here to see this topic
Compiling and running a Java program
Click here to see this topic
R<;_-DZ#`s
;l5{s
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Represents the Notes databases on a specific server or local computer.
Syntax
public class lotus.notes.DbDirectory extends NotesBase
Containmentt
Contained by:
Click here to see this topic
lotus.notes.Session
Click here to see this topic
Contains:
Click here to see this topic
lotus.notes.Database
Click here to see this topic
Properties
Click here to see this topic
Name
Click here to see this topic
through getName
Methods
Click here to see this topic
createDatabase
Click here to see this topic
Click here to see this topic
etFirstDatabase
Click here to see this topic
Click here to see this topic
etNextDatabase
Click here to see this topic
Click here to see this topic
openDatabase
Click here to see this topic
Click here to see this topic
openDatabaseIfModified
Click here to see this topic
Click here to see this topic
openDatabaseByReplicaID
Click here to see this topic
Click here to see this topic
openMailDatabase
Click here to see this topic
Creation
You create a new lotus.notes.DbDirectory object with
Click here to see this topic
get
DbDirectory
Click here to see this topic
in lotus.notes.Session.
Click here to see this topic
See examples
See related topics
Click here to see this topic
Compiling and running a Java program
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Represents a collection of documents from a database, selected according to specific criteria.
Syntax
public class lotus.notes.DocumentCollection extends NotesBase
Containment
Contained by:
Click here to see this topic
lotus.notes.Database
Click here to see this topic
Click here to see this topic
lotus.notes.Session%
Click here to see this topic
Click here to see this topic
lotus.notes.View
Click here to see this topic
Contains:
Click here to see this topic
lotus.notes.Document
Click here to see this topic
Properties
Click here to see this topic
Count
Click here to see this topic
through getCount
Click here to see this topic
IsSorted
Click here to see this topic
through isSorted
Click here to see this topic
Parent
Click here to see this topic
through getParent
Click here to see this topic
Querye
Click here to see this topic
through getQuery
Methods
Click here to see this topic
Search
Click here to see this topic
Click here to see this topic
etFirstDocumente
Click here to see this topic
Click here to see this topic
etLastDocument
Click here to see this topic
Click here to see this topic
etNextDocument
Click here to see this topic
Click here to see this topic
etNthDocumento
Click here to see this topic
Click here to see this topic
etPrevDocument
Click here to see this topic
Click here to see this topic
utAllInFolder
Click here to see this topic
Click here to see this topic
emoveAll method
Click here to see this topic
Click here to see this topic
emoveAllFromFolder methode
Click here to see this topic
Click here to see this topic
tampAll method
Click here to see this topic
Click here to see this topic
pdateAll method
Click here to see this topic
Access
A lotus.notes.DocumentCollection represents a subset of all the documents in a database. The documents in the subset are determined by the lotus.notes.Database method or property you use to search the database, which can be any of the following:
Click here to see this topic
AllDocuments property
Click here to see this topic
Click here to see this topic
UnprocessedDocuments property
Click here to see this topic
Click here to see this topic
earch method
Click here to see this topic
Click here to see this topic
nprocessedSearch methodo
Click here to see this topic
Click here to see this topic
Search methoda
Click here to see this topic
Click here to see this topic
nprocessedFTSearch method
Click here to see this topic
The
Click here to see this topic
Responses property
Click here to see this topic
in lotus.notes.Document also returns a lotus.notes.DocumentCollection.
Usagee
Both lotus.notes.DocumentCollection and
Click here to see this topic
lotus.notes.View
Click here to see this topic
objects provide access to documents within a database. Use a lotus.notes.DocumentCollection object if:n
You want to act on a specific set of documents that meet certain criteria.
There is no view in the database that contains every document you need to search.n
You do not need to navigate the documents' response hierarchies.
Views are a more efficient means of accessing documents because they are already indexed by the database itself. However, they do not necessarily provide access to the documents that you want.
Ordering of documentsl
The documents in a collection are ordered when the collection results from a full text search; otherwise, the documents are unordered.
Click here to see this topic
See examples
See related topics
Click here to see this topic
Compiling and running a Java program
Click here to see this topic
uS*|=
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Represents a document in a database.
Syntax
public class lotus.notes.Document extends NotesBase
Containment
Contained by:
Click here to see this topic
lotus.notes.Database
Click here to see this topic
Click here to see this topic
lotus.notes.DocumentCollection
Click here to see this topic
Click here to see this topic
lotus.notes.Newsletter
Click here to see this topic
Click here to see this topic
lotus.notes.View
Click here to see this topic
Contains:
Click here to see this topic
lotus.notes.DateTime
Click here to see this topic
Click here to see this topic
lotus.notes.EmbeddedObject
Click here to see this topic
Click here to see this topic
lotus.notes.Item
Click here to see this topic
Click here to see this topic
lotus.notes.RichTextItem
Click here to see this topic
Properties
Click here to see this topic
Authors
Click here to see this topic
through getAuthors
Click here to see this topic
ColumnValues
Click here to see this topic
through getColumnValues
Click here to see this topic
Created
Click here to see this topic
through getCreated
Click here to see this topic
EmbeddedObjectsn
Click here to see this topic
through getEmbeddedObjects
Click here to see this topic
EncryptionKeys
Click here to see this topic
through getEncryptionKeys and setEncryptionKeys
Click here to see this topic
FTSearchScore
Click here to see this topic
through getFTSearchScore
Click here to see this topic
asEmbedded
Click here to see this topic
through hasEmbedded
Click here to see this topic
IsEncryptOnSend
Click here to see this topic
through isEncryptOnSend and setEncryptOnSendt
Click here to see this topic
sNewNote
Click here to see this topic
through isNewNote
Click here to see this topic
sProfile
Click here to see this topic
through isProfile
Click here to see this topic
sResponsem
Click here to see this topic
through isResponset
Click here to see this topic
IsSaveMessageOnSendl
Click here to see this topic
through isSaveMessageOnSend and setSaveMessageOnSendi
Click here to see this topic
IsSentByAgent
Click here to see this topic
through isSentByAgent
Click here to see this topic
sSigned
Click here to see this topic
through isSigned
Click here to see this topic
IsSignOnSend
Click here to see this topic
through isSignOnSend and setSignOnSend
Click here to see this topic
Itemss
Click here to see this topic
through getItemsn
Click here to see this topic
Key
Click here to see this topic
through getKeye
Click here to see this topic
LastAccessed
Click here to see this topic
through getLastAccessed
Click here to see this topic
LastModified
Click here to see this topic
through getLastModified
Click here to see this topic
NameOfProfilem
Click here to see this topic
through getNameOfProfilef
Click here to see this topic
NoteID
Click here to see this topic
through getNoteID
Click here to see this topic
ParentDatabase
Click here to see this topic
through getParentDatabase
Click here to see this topic
ParentDocumentUNID
Click here to see this topic
through getParentDocumentUNID
Click here to see this topic
ParentView
Click here to see this topic
through getParentView
Click here to see this topic
Responsesc
Click here to see this topic
through getResponsesr
Click here to see this topic
Signer
Click here to see this topic
through getSigner
Click here to see this topic
Size
Click here to see this topic
through getSize
Click here to see this topic
UniversalIDo
Click here to see this topic
through getUniversalID and setUniversalID
Click here to see this topic
Verifier
Click here to see this topic
through getVerifier
Methods
Click here to see this topic
ppendItemValue
Click here to see this topic
Click here to see this topic
omputeWithForm
Click here to see this topic
Click here to see this topic
opyAllItemsf
Click here to see this topic
Click here to see this topic
opyItemy
Click here to see this topic
Click here to see this topic
opyToDatabasei
Click here to see this topic
Click here to see this topic
createReplyMessage
Click here to see this topic
Click here to see this topic
reateRichTextItem
Click here to see this topic
Click here to see this topic
encrypt
Click here to see this topic
Click here to see this topic
etAttachment
Click here to see this topic
Click here to see this topic
getFirstItem
Click here to see this topic
Click here to see this topic
etItemValuel
Click here to see this topic
Click here to see this topic
etItemValueDouble
Click here to see this topic
Click here to see this topic
etItemValueInteger
Click here to see this topic
Click here to see this topic
etItemValueString
Click here to see this topic
Click here to see this topic
asItem
Click here to see this topic
Click here to see this topic
makeResponse
Click here to see this topic
Click here to see this topic
putInFolder
Click here to see this topic
Click here to see this topic
remove
Click here to see this topic
Click here to see this topic
removeFromFolder
Click here to see this topic
Click here to see this topic
removeItem
Click here to see this topic
Click here to see this topic
renderToRTItem
Click here to see this topic
Click here to see this topic
replaceItemValue
Click here to see this topic
Click here to see this topic
save
Click here to see this topic
Click here to see this topic
send
Click here to see this topic
Click here to see this topic
sign
Click here to see this topic
Creation
To create a new lotus.notes.Document object, use e
Click here to see this topic
reateDocument
Click here to see this topic
in lotus.notes.Database
Access
There are several ways to access an existing document.
To get a document based on its position in a view, use a e
Click here to see this topic
lotus.notes.View
Click here to see this topic
object.
To get a document based on its position in a response hierarchy, use a
Click here to see this topic
lotus.notes.View
Click here to see this topic
object.
To get a document based on its NoteID or UNID, use
Click here to see this topic
etDocumentByID
Click here to see this topic
or
Click here to see this topic
etDocumentByUNID
Click here to see this topic
in lotus.notes.Database.(
To get all the documents in a database, use
Click here to see this topic
llDocuments
Click here to see this topic
in lotus.notes.Database.
To get all the documents that match a full text search query of a view or a database, use
Click here to see this topic
Search
Click here to see this topic
in lotus.notes.View or lotus.notes.Database.e
To get all the documents in a database that meet search criteria, where the criteria are defined using the Notes formula language, use
Click here to see this topic
earch
Click here to see this topic
in lotus.notes.Database.e
To get documents in a database that have not been processed by the current agent, use
Click here to see this topic
UnprocessedDocuments
Click here to see this topic
in lotus.notes.Database.
To get all of the documents that are responses to a particular document, use
Click here to see this topic
Responsesl
Click here to see this topic
in lotus.notes.Document.
To get a response document's parent document, use
Click here to see this topic
ParentDocumentUNID
Click here to see this topic
in lotus.notes.Document and l
Click here to see this topic
getDocumentByUNID method
Click here to see this topic
in lotus.notes.Database.
Once you have a view, you can navigate to a specific document using methods in the lotus.notes.View class.
Once you have a collection of documents, you can navigate to a specific document using methods in the
Click here to see this topic
lotus.notes.DocumentCollection class
Click here to see this topic
Saving changes
After you create, modify, or delete a document, you must save the changes by calling the save method.
If you don't call save before the script finishes, all of your changes to a lotus.notes.Document are lost. Call save every time you want to keep your changes.
If you create a new document, but do not add any items to it, the document is not saved to disk, even if you invoke the save method.
Additional propertiesu
In addition to the properties listed, you can also treat an item name as a property of a lotus.notes.Document object. For example, the following line of code sets the value of the Subject item on a document to "Hello":
doc.Subject = "Hello";
For more information, see the
Click here to see this topic
ppendItemValue
Click here to see this topic
and
Click here to see this topic
eplaceItemValue
Click here to see this topic
methods.g
Encryption
A program attempts to decrypt an encrypted document the first time the program accesses one of the lotus.notes.Document properties or methods. If decryption fails, an error is raised.
Click here to see this topic
See examples
See related topics
Click here to see this topic
Compiling and running a Java program
Click here to see this topic
NKuls
~3X@?
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Represents any one of the following:
An embedded object
An object link
A file attachment
Some methods and properties that are available for embedded and linked objects are unavailable for file attachments.
Note
lotus.notes.EmbeddedObject is not supported under OS/2, under UNIX, and on the Macintosh.
Syntax
public class lotus.notes.EmbeddedObject extends NotesBase
Containment
Contained by:
Click here to see this topic
lotus.notes.Document
Click here to see this topic
and
Click here to see this topic
lotus.notes.RichTextItem
Click here to see this topic
Properties
Click here to see this topic
ClassName
Click here to see this topic
through getClassName
Click here to see this topic
FileSize
Click here to see this topic
through getFileSize
Click here to see this topic
Name
Click here to see this topic
through getName
Click here to see this topic
Object
Click here to see this topic
through getObject
Click here to see this topic
Parent
Click here to see this topic
through getParent
Click here to see this topic
Source
Click here to see this topic
through getSource
Click here to see this topic
Type
Click here to see this topic
through getType
Click here to see this topic
Verbs
Click here to see this topic
through getVerbs
Methods
Click here to see this topic
activate
Click here to see this topic
Click here to see this topic
oVerb
Click here to see this topic
Click here to see this topic
xtractFile
Click here to see this topic
Click here to see this topic
emove.
Click here to see this topic
Creation
To create a new object, object link, or file attachment, use h
Click here to see this topic
mbedObject
Click here to see this topic
in lotus.notes.RichTextItem.
Access
There are several ways to access an existing object, object link, or file attachment:V
To access an object, object link, or attachment when you know its name and the rich text item that contains it, use
Click here to see this topic
etEmbeddedObject
Click here to see this topic
in lotus.notes.RichTextItem.t
To access all the objects, object links, and attachments in a particular rich text item, use s
Click here to see this topic
EmbeddedObjectsf
Click here to see this topic
in lotus.notes.RichTextItem.d
To access the objects and object links in a particular document, including those that are not contained within a particular rich text item, use
Click here to see this topic
EmbeddedObjectso
Click here to see this topic
in lotus.notes.Document. This property does not return file attachments or objects and object links created in Notes Release 3.
Click here to see this topic
See examples
See related topics
Click here to see this topic
Compiling and running a Java program
Click here to see this topic
<]Nohps
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-Write. Font rich text attribute as listed below.F
Defined in
Click here to see this topic
lotus.notes.
RichTextStyle
Click here to see this topic
Data type
Syntax
public int getFont()
throws NotesException
public void setFont(int value)
throws NotesException
Legal values
FONT_COURIER
FONT_HELV
FONT_ROMAN
STYLE_NO_CHANGE to maintain the previous state
Click here to see this topic
See examples
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Represents a form in a database.
Syntax
public class lotus.notes.Form extends NotesBase
Containment
Contained by:
Click here to see this topic
lotus.notes.Database
Click here to see this topic
Properties
Click here to see this topic
Aliasesi
Click here to see this topic
through getAliaseso
Click here to see this topic
Fields
Click here to see this topic
through getFields
Click here to see this topic
FormUser
Click here to see this topic
through getFormUsers and setFormUsers
Click here to see this topic
IsProtectReaders
Click here to see this topic
through isProtectReaders and setProtectReadersr
Click here to see this topic
IsProtectUsers
Click here to see this topic
through isProtectUsers and setProtectUsersm
Click here to see this topic
sSubForm
Click here to see this topic
through isSubForm
Click here to see this topic
Name
Click here to see this topic
through getName
Click here to see this topic
Readers
Click here to see this topic
through getReaders and setReaders
Methods
Click here to see this topic
emoven
Click here to see this topic
Access
There are two ways to access a form:
To get all the forms in a database, use
Click here to see this topic
Formsu
Click here to see this topic
in lotus.notes.Database.h
To get a form by its name, use
Click here to see this topic
getForm
Click here to see this topic
in lotus.notes.Database.
You can't get access to private forms belonging to other people.
Click here to see this topic
See examples
See related topics
Click here to see this topic
Compiling and running a Java program
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Represents the international settings in the operating environment, for example, the Regional Settings in the Windows Control Panel. When settings change in the operating environment, Notes recognizes the new settings immediately.
Syntax
public class lotus.notes.International extends NotesBase
Containment
Contained by:
Click here to see this topic
lotus.notes.Session
Click here to see this topic
Properties
Click here to see this topic
AMString
Click here to see this topic
through getAMString
Click here to see this topic
CurrencyDigits
Click here to see this topic
through getCurrencyDigits
Click here to see this topic
CurrencySymbol
Click here to see this topic
through getCurrencySymbol
Click here to see this topic
DateSep
Click here to see this topic
through getDateSepn
Click here to see this topic
DecimalSep
Click here to see this topic
through getDecimalSep
Click here to see this topic
sCurrencySpace
Click here to see this topic
through isCurrencySpace
Click here to see this topic
IsCurrencySuffix
Click here to see this topic
through isCurrencySuffixe
Click here to see this topic
sCurrencyZeroC
Click here to see this topic
through isCurrencyZeroN
Click here to see this topic
sDateDMY
Click here to see this topic
through isDateDMY
Click here to see this topic
sDateMDY
Click here to see this topic
through isDateMDY
Click here to see this topic
sDateYMD
Click here to see this topic
through isDateYMD
Click here to see this topic
sDST
Click here to see this topic
through isDST
Click here to see this topic
sTime24Hour
Click here to see this topic
through isTime24Hour
Click here to see this topic
PMString
Click here to see this topic
through getPMString
Click here to see this topic
ThousandsSep
Click here to see this topic
through getThousandsSep
Click here to see this topic
TimeSep
Click here to see this topic
through getTimeSep
Click here to see this topic
TimeZone
Click here to see this topic
through getTimeZone
Click here to see this topic
Todayo
Click here to see this topic
through getToday
Click here to see this topic
Tomorrow
Click here to see this topic
through getTomorrow
Click here to see this topic
Yesterday
Click here to see this topic
through getYesterday
Access
Access a lotus.notes.International object for the current session through
Click here to see this topic
getInternational
Click here to see this topic
in lotus.notes.Session.
Click here to see this topic
See examples
Click here to see this topic
See related topics
Click here to see this topic
Accessing international settings
Click here to see this topic
Click here to see this topic
Compiling and running a Java program
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Represents a piece of data in a document.
In the user interface, Notes displays items in a document through fields on a form. When a field on a form and an item in a document have the same name, the field displays the item (for example, the Subject field displays the Subject item).
All of the items in a document are accessible programmatically, regardless of what form is used to display the document in the user interface.
Syntax
public class lotus.notes.Item extends NotesBase@
Derived ClassesG
Click here to see this topic
lotus.notes.RichTextItem
Click here to see this topic
inherits from lotus.notes.Item class.
Containment
Contained by:
Click here to see this topic
lotus.notes.Document
Click here to see this topic
Properties
Click here to see this topic
DateTimeValue
Click here to see this topic
through getDateTimeValue and setDateTimeValue
Click here to see this topic
sAuthors
Click here to see this topic
through isAuthors and setAuthors
Click here to see this topic
sEncrypted
Click here to see this topic
through isEncrypted and setEncrypted
Click here to see this topic
sNames
Click here to see this topic
through isNames and setNames
Click here to see this topic
sProtected
Click here to see this topic
through isProtected and setProtected
Click here to see this topic
sReaders
Click here to see this topic
through isReaders and setReaders
Click here to see this topic
IsSaveToDisk
Click here to see this topic
through isSaveToDisk and setSaveToDiske
Click here to see this topic
sSignedc
Click here to see this topic
through isSigned and setSigned
Click here to see this topic
sSummary
Click here to see this topic
through isSummary and setSummary,
Click here to see this topic
LastModified
Click here to see this topic
through getLastModified
Click here to see this topic
Name
Click here to see this topic
through getName
Click here to see this topic
Parent
Click here to see this topic
through getParent
Click here to see this topic
Text
Click here to see this topic
through getText
Click here to see this topic
Type
Click here to see this topic
through getType
Click here to see this topic
ValueDoublee
Click here to see this topic
through getValueDouble2
Click here to see this topic
ValueInteger
Click here to see this topic
through getValueInteger
Click here to see this topic
ValueLength
Click here to see this topic
through getValueLength
Click here to see this topic
Values
Click here to see this topic
through getValues and setValues
Click here to see this topic
ValueStringa
Click here to see this topic
through getValueStringm
Methodso
Click here to see this topic
bstractText
Click here to see this topic
Click here to see this topic
ppendToTextList
Click here to see this topic
Click here to see this topic
ontainsValue
Click here to see this topic
Click here to see this topic
opyItemToDocument
Click here to see this topic
Click here to see this topic
remove
Click here to see this topic
Creation
There are two ways to create a new lotus.notes.Item object:
To create one from scratch, use
Click here to see this topic
ppendItemValue
Click here to see this topic
or
Click here to see this topic
eplaceItemValuen
Click here to see this topic
in lotus.notes.Document.n
To create a new lotus.notes.Item object from one that already exists, use
Click here to see this topic
opyItemToDocumentm
Click here to see this topic
, or s
Click here to see this topic
opyItemp
Click here to see this topic
, or c
Click here to see this topic
eplaceItemValuee
Click here to see this topic
in lotus.notes.Document.
You must call
Click here to see this topic
aver
Click here to see this topic
on the document if you want the modified document to be saved to disk. The document won't display the new item in the user interface unless there is a field of the same name on the form used to display the document.
Usage
You must explicitly call setSummary and specify True if you want the value to be displayed in a view or folder.a
Access
There are several ways to access an existing lotus.notes.Item object.
To access an item when you know its name, use
Click here to see this topic
etFirstItemr
Click here to see this topic
in lotus.notes.Document.p
To access all the items in a document, use
Click here to see this topic
Items
Click here to see this topic
in lotus.notes.Document.
Accessing items directly from a document
For convenience, lotus.notes.Document has methods you can use to access items without declaring a lotus.notes.Item object. All you need to know is the name of the item:
To get an item's value, use
Click here to see this topic
etItemValueu
Click here to see this topic
To set an item's value, use
Click here to see this topic
eplaceItemValuei
Click here to see this topic
To create a new item, use
Click here to see this topic
ppendItemValue
Click here to see this topic
To check for the existence of a particular item in a document, use h
Click here to see this topic
asItem
Click here to see this topic
To delete an item from a document, use
Click here to see this topic
emoveItem
Click here to see this topic
Rich text fields
lotus.notes.RichTextItem, which inherits the properties and methods of lotus.notes.Item, has additional properties and methods you can use to manipulate a rich text item.
Saving Changes
After you create or modify an item, you must save the changes by calling the parent document's save method.
If you don't call save before the program finishes, all of your changes to a lotus.notes.Item object are lost.
Click here to see this topic
See examples
See related topics
Click here to see this topic
Compiling and running a Java program
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Enables you to record actions and errors that take place during a program's execution. You can record actions and errors in:
A Notes database
A mail memo
A file (for programs that run locally)
An agent log (for agents)l
Syntax
public class lotus.notes.Log extends NotesBase
Containment
Contained by:
Click here to see this topic
lotus.notes.Session
Click here to see this topic
Properties
Click here to see this topic
IsLogActions
Click here to see this topic
through isLogActions and setLogActionst
Click here to see this topic
IsLogErrors
Click here to see this topic
through isLogErrors and setLogErrors
Click here to see this topic
IsOverwriteFile
Click here to see this topic
through isOverwriteFile and setOverwriteFile
Click here to see this topic
NumActions
Click here to see this topic
through getNumActions
Click here to see this topic
NumErrorsg
Click here to see this topic
through getNumErrorsA
Click here to see this topic
ProgramNamea
Click here to see this topic
through getProgramName and setProgramName
Methodsc
Click here to see this topic
closet
Click here to see this topic
Click here to see this topic
logAction
Click here to see this topic
Click here to see this topic
ogErrorc
Click here to see this topic
Click here to see this topic
ogEventu
Click here to see this topic
Click here to see this topic
penAgent
Logt
Click here to see this topic
Click here to see this topic
penFileLog
Click here to see this topic
Click here to see this topic
penMailLog
Click here to see this topic
Click here to see this topic
penNotes
Logc
Click here to see this topic
Creation
To create a new log, use e
Click here to see this topic
reateLog
Click here to see this topic
in lotus.notes.Session.
Usaged
Once you create a log, you use one of the following methods to open it before you begin logging:
To log to a database, use
Click here to see this topic
penNotes
Log
Click here to see this topic
To log to a mail memo, use
Click here to see this topic
penMailLog
Click here to see this topic
To log to a file (only available to programs running locally), use I
Click here to see this topic
penFileLog
Click here to see this topic
To log to an agent log (only available to agents), use
Click here to see this topic
penAgent
Log7
Click here to see this topic
You must explicitly log each action and error using the following methods:
To log an action, use
Click here to see this topic
logAction
Click here to see this topic
To log an error, use
Click here to see this topic
ogError
Click here to see this topic
Notes does not automatically log actions or errors for you.
Click here to see this topic
See examples
Click here to see this topic
See related topics
Click here to see this topic
Compiling and running a Java program
Click here to see this topic
Click here to see this topic
Making a Notes log
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Represents a user or server name.
Syntax
public class lotus.notes.Name extends NotesBasee
Containment
Contained by:
Click here to see this topic
lotus.notes.Sessione
Click here to see this topic
Properties
Click here to see this topic
Abbreviatedr
Click here to see this topic
through getAbbreviatedm
Click here to see this topic
ADMD
Click here to see this topic
through getADMD
Click here to see this topic
Canonicalj
Click here to see this topic
through getCanonicalr
Click here to see this topic
Common
Click here to see this topic
through getCommon
Click here to see this topic
Countryl
Click here to see this topic
through getCountrya
Click here to see this topic
Generation
Click here to see this topic
through getGeneration
Click here to see this topic
Given=
Click here to see this topic
through getGivenj
Click here to see this topic
Initials
Click here to see this topic
through getInitials
Click here to see this topic
sHierarchical
Click here to see this topic
through isHierarchical.
Click here to see this topic
Keyword
Click here to see this topic
through getKeywordR
Click here to see this topic
Organization
Click here to see this topic
through getOrganization
Click here to see this topic
OrgUnit1
Click here to see this topic
through getOrgUnit1
Click here to see this topic
OrgUnit2
Click here to see this topic
through getOrgUnit2
Click here to see this topic
OrgUnit3
Click here to see this topic
through getOrgUnit3
Click here to see this topic
OrgUnit4
Click here to see this topic
through getOrgUnit4
Click here to see this topic
PRMD
Click here to see this topic
through getPRMD
Click here to see this topic
Surname
Click here to see this topic
through getSurnamee
Creation
To create a new lotus.notes.Name object, use
Click here to see this topic
createName
Click here to see this topic
in lotus.notes.Session.
Usagee
The properties of this class can be interrogated to distinguish different elements of the name.t
Click here to see this topic
See examples
Click here to see this topic
See related topics
Click here to see this topic
Compiling and running a Java program
Click here to see this topic
Click here to see this topic
Representing a name
Click here to see this topic
V\W4s
;ZLre
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
A document or set of documents that contains information from, or links to, several other documents.
Syntax
public class lotus.notes.Newsletter extends NotesBase
Containment
Contained by:
Click here to see this topic
lotus.notes.Session
Click here to see this topic
Contains:
Click here to see this topic
lotus.notes.Document
Click here to see this topic
Properties
Click here to see this topic
IsDoScoreI
Click here to see this topic
through isDoScore and setDoScoree
Click here to see this topic
IsDoSubject
Click here to see this topic
through isDoSubject and setDoSubject
Click here to see this topic
SubjectItemName
Click here to see this topic
through getSubjectItemName and setSubjectItemName
Methods
Click here to see this topic
ormatDocument
Click here to see this topic
Click here to see this topic
ormatMsgWithDoclinks
Click here to see this topic
Creation
To create a new lotus.notes.Newsletter, use a
Click here to see this topic
lotus.notes.DocumentCollection objecte
Click here to see this topic
containing the documents you want with
Click here to see this topic
reateNewsletter
Click here to see this topic
in lotus.notes.Session.
Usage
Once you create a newsletter, you can:
Use
Click here to see this topic
ormatDocument
Click here to see this topic
to create a new document with a rendering (picture) of one of the documents in the collection.s
Use
Click here to see this topic
ormatMsgWithDoclinks
Click here to see this topic
to create a new document with links to each of the documents in the collection.
Click here to see this topic
See examples
Click here to see this topic
See related topics
Click here to see this topic
Compiling and running a Java program
Click here to see this topic
Click here to see this topic
Making a Notes newsletter
Click here to see this topic
1l8ps
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Represents the creation or administration of an ID file.
Syntax
public class lotus.notes.Registration extends NotesBase
ContainmentF
Contained by
Click here to see this topic
NotesSession class
Click here to see this topic
Properties
Click here to see this topic
CertifierIDFile property
Click here to see this topic
through getCertifierIDFile and setCertifierIDFile
Click here to see this topic
CreateMailDb property
Click here to see this topic
through getCreateMailDb and setCreateMailDb
Click here to see this topic
Expiration propertyu
Click here to see this topic
through getExpiration and setExpiration
Click here to see this topic
IDType property
Click here to see this topic
through getIDType and setIDType
Click here to see this topic
IsNorthAmerican property
Click here to see this topic
through isNorthAmerican and setNorthAmericane
Click here to see this topic
MinPasswordLength property
Click here to see this topic
through getMinPasswordLength and setMinPasswordLength
Click here to see this topic
OrgUnit property
Click here to see this topic
through getOrgUnit and setOrgUnit
Click here to see this topic
RegistrationLog property
Click here to see this topic
through getRegistrationLog and setRegistrationLog
Click here to see this topic
RegistrationServer property
Click here to see this topic
through getRegistrationServer and setRegistrationServer
Click here to see this topic
StoreIDIn
AddressBook property
Click here to see this topic
through getStoreIDToAddressBook and setStoreIDToAddressBook
Click here to see this topic
UpdateAddressbook property
Click here to see this topic
through getUpdateAddressBook and setUpdateAddressBook
Methods
Click here to see this topic
AddCertifierToAddressbook method
Click here to see this topic
Click here to see this topic
AddServerToAddressbook method
Click here to see this topic
Click here to see this topic
AddUserProfile method
Click here to see this topic
Click here to see this topic
AddUserToAddressBook method
Click here to see this topic
Click here to see this topic
CrossCertify methodh
Click here to see this topic
Click here to see this topic
DeleteIDOnServer methodT
Click here to see this topic
Click here to see this topic
GetIDFromServer method
Click here to see this topic
Click here to see this topic
GetUserInfoFromServer method
Click here to see this topic
Click here to see this topic
Recertify method
Click here to see this topic
Click here to see this topic
RegisterNewCertifier methodo
Click here to see this topic
Click here to see this topic
RegisterNewServer method
Click here to see this topic
Click here to see this topic
RegisterNewUser method
Click here to see this topic
Click here to see this topic
SwitchToID methodE
Click here to see this topic
Creation
To create a new NotesRegistration object, use the
Click here to see this topic
CreateRegistration method
Click here to see this topic
in lotus.notes.Session.
Click here to see this topic
See examples
See related topics
Click here to see this topic
Compiling and running a Java program
Click here to see this topic
bF';n^s
bF';n^s
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Represents an item of type rich text.v
Syntax
public class lotus.notes.RichTextItem extends lotus.notes.Item
Base class
Inherits from:
Click here to see this topic
lotus.notes.Item
Click here to see this topic
Containment
Contained by:
Click here to see this topic
lotus.notes.Document
Click here to see this topic
Contains:
Click here to see this topic
lotus.notes.EmbeddedObject
Click here to see this topic
Property
Click here to see this topic
EmbeddedObjects
Click here to see this topic
through getEmbeddedObjectss
Methods
Click here to see this topic
addNewLine
Click here to see this topic
Click here to see this topic
addTab
Click here to see this topic
Click here to see this topic
ppendDocLink
Click here to see this topic
Click here to see this topic
appendRTItem
Click here to see this topic
Click here to see this topic
appendStyle
Click here to see this topic
Click here to see this topic
appendText
Click here to see this topic
Click here to see this topic
embedObjectw
Click here to see this topic
Click here to see this topic
getEmbeddedObjects
Click here to see this topic
Click here to see this topic
getFormattedText
Click here to see this topic
Creation
To create a new lotus.notes.RichTextItem object, use e
Click here to see this topic
reateRichTextItem method
Click here to see this topic
in lotus.notes.Document
Access
To access an existing lotus.notes.RichTextItem object, use the f
Click here to see this topic
etFirstItems
Click here to see this topic
method in lotus.notes.Document.
Usager
Because lotus.notes.RichTextItem inherits from lotus.notes.Item, all of the lotus.notes.Item properties and methods can be used on a lotus.notes.RichTextItem, too.m
When you change the value of a lotus.notes.RichTextItem object, the change is not written to disk until you call
Click here to see this topic
ave
Click here to see this topic
for the parent lotus.notes.Document object.
Click here to see this topic
See examples
See related topics
Click here to see this topic
Compiling and running a Java program
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Represents rich text attributes.
Syntax
public class lotus.notes.RichTextStyle extends NotesBase
Containment7
Contained by:
Click here to see this topic
lotus.notes.Session
Click here to see this topic
and e
Click here to see this topic
lotus.notes.RichTextItem
Click here to see this topic
Properties
Click here to see this topic
Bold
Click here to see this topic
through getBold and setBold
Click here to see this topic
Color
Click here to see this topic
through getColor and setColor
Click here to see this topic
Effects
Click here to see this topic
through getEffects and setEffects
Click here to see this topic
Font
Click here to see this topic
through getFont and setFont
Click here to see this topic
FontSize
Click here to see this topic
through getFontSize and setFontSize
Click here to see this topic
Italic
Click here to see this topic
through getItalic and setItalic
Click here to see this topic
StrikeThroughe
Click here to see this topic
through getStrikeThrough and setStrikeThrough
Click here to see this topic
Underline
Click here to see this topic
through getUnderline and setUnderline
Creation
To create a new NotesRichTextStyle object, use
Click here to see this topic
reateRichTextStyle
Click here to see this topic
in lotus.notes.NotesSession.
Access
Use a NotesRichTextStyle object with N
Click here to see this topic
ppendStyle
Click here to see this topic
of lotus.notes.RichTextItem.
At creation, all the lotus.notes.RichTextStyle properties are STYLE_NO_CHANGE.
Click here to see this topic
See examples
See related topics
Click here to see this topic
Compiling and running a Java program
Click here to see this topic
]6VGA
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Is the root of the Notes back-end object containment hierarchy, providing access to the other Notes objects, and represents the Notes environment of the current program.c
Syntax
public class lotus.notes.Session extends NotesBase
static public Session newInstance()
throws NotesException
Containment
Contains:
Click here to see this topic
lotus.notes.AgentContext
Click here to see this topic
Click here to see this topic
lotus.notes.Database
Click here to see this topic
Click here to see this topic
lotus.notes.DateRange
Click here to see this topic
Click here to see this topic
lotus.notes.DateTime
Click here to see this topic
Click here to see this topic
lotus.notes.DbDirectory
Click here to see this topic
Click here to see this topic
lotus.notes.DocumentCollection
Click here to see this topic
Click here to see this topic
lotus.notes.Internationale
Click here to see this topic
Click here to see this topic
lotus.notes.Loge
Click here to see this topic
Click here to see this topic
lotus.notes.Name
Click here to see this topic
Click here to see this topic
lotus.notes.Newsletter
Click here to see this topic
Properties
Click here to see this topic
AddressBooks
Click here to see this topic
through getAddressBooks
Click here to see this topic
AgentContext
Click here to see this topic
through getAgentContext
Click here to see this topic
CommonUserName
Click here to see this topic
through getCommonUserName
Click here to see this topic
Internationalp
Click here to see this topic
through getInternationals
Click here to see this topic
IsOnServer
Click here to see this topic
through isOnServern
Click here to see this topic
NotesVersion
Click here to see this topic
through getNotesVersion
Click here to see this topic
Platform
Click here to see this topic
through getPlatform
Click here to see this topic
UserName
Click here to see this topic
through getUserName
Click here to see this topic
UserNameObject
Click here to see this topic
through getUserNameObject
Methods
Click here to see this topic
createDateRange'
Click here to see this topic
Click here to see this topic
reateDateTimeo
Click here to see this topic
Click here to see this topic
reateLog
Click here to see this topic
Click here to see this topic
createName
Click here to see this topic
Click here to see this topic
createNewsletter
Click here to see this topic
Click here to see this topic
createRegistration
Click here to see this topic
Click here to see this topic
createRichTextStyle
Click here to see this topic
Click here to see this topic
evaluate
Click here to see this topic
Click here to see this topic
freeTimeSearch
Click here to see this topic
Click here to see this topic
getDatabasen
Click here to see this topic
Click here to see this topic
getDbDirectory
Click here to see this topic
Click here to see this topic
getEnvironmentString
Click here to see this topic
Click here to see this topic
getEnvironmentValue)
Click here to see this topic
Click here to see this topic
openURLDatabaseA
Click here to see this topic
Click here to see this topic
setEnvironmentVarV
Click here to see this topic
Creation and accessi
For stand-alone programs, use the method newInstance() to create a Session object.
For agents, use the AgentBase method getSession().
To access the current session from a lotus.notes.Database object, use the
Click here to see this topic
Parent propertyg
Click here to see this topic
in lotus.notes.Database
Usageo
Since there can only be one session per program, the constructor always returns the same object each time you call it.
Click here to see this topic
See examples
Click here to see this topic
See related topics
Click here to see this topic
Compiling and running a Java program
Click here to see this topic
Click here to see this topic
Ways to access Notes sessions
Click here to see this topic
{z_]s
]6VGA
6db<}
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
The NotesThread class extends java.lang.Thread to include special initialization and termination code for Notes. This extension to Thread is required to run Java programs that use the Notes classes.
The class NotesThread
The specification of the class NotesThread is as follows:
public class NotesThread extends java.lang.Thread {
public NotesThread()
public NotesThread(Runnable t)
public void initThread()
public static void sinitThread()
public void termThread()
public static void stermThread()
public void runNotes()
static public void load(boolean debug)
Executing threads through inheritanceV
To execute threads through inheritance, extend NotesThread instead of Thread and include a runNotes method instead of run:
public class myClass extends NotesThread {
public void runNotes() {
// my code
}
Start a Notes thread the same as any thread:
myClass m = new myClass();
m.start();
Executing threads through the Runnable interface
To execute threads through the Runnable interface, implement Runnable and include a run method as you would for any class using threads:
public class myClass implements Runnable {
public void run() {
// my code
}
You might include both run and runNotes methods so the class works whether you specify "implements Runnable" or "extends NotesThread":
public class myClass implements Runnable {
public void run() {
this.runNotes();
}
public void runNotes() {
// my code
}
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. The release of Notes in the local Notes directory.
Defined in
Click here to see this topic
lotus.notes.Session
Click here to see this topic
Data type
String
Syntax
public String getNotesVersion()
throws NotesException
Click here to see this topic
See examples
Click here to see this topic
See related topics
Click here to see this topic
Accessing session properties
Click here to see this topic
Click here to see this topic
Platform property@
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Represents a column in a view or folder.
Syntax
public class lotus.notes.ViewColumn extends NotesBase
Containment
Contained by:
Click here to see this topic
lotus.notes.View
Click here to see this topic
Properties
Click here to see this topic
Formula
Click here to see this topic
through getFormula
Click here to see this topic
sCategory
Click here to see this topic
through isCategory
Click here to see this topic
sHidden
Click here to see this topic
through isHidden1
Click here to see this topic
sResponser
Click here to see this topic
through isResponse
Click here to see this topic
sSorted
Click here to see this topic
through isSortedQ
Click here to see this topic
ItemName
Click here to see this topic
through getItemName
Click here to see this topic
Position
Click here to see this topic
through getPosition
Click here to see this topic
Title
Click here to see this topic
through getTitle
Click here to see this topic
Width
Click here to see this topic
through getWidth
Access
You access an existing lotus.notes.ViewColumn object through the view or folder that contains it. Use
Click here to see this topic
Columns property
Click here to see this topic
in lotus.notes.View.
Click here to see this topic
See examples
See related topics
Click here to see this topic
ColumnValues propertyl
Click here to see this topic
Click here to see this topic
Compiling and running a Java program
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Represents a view or folder of a database and provides access to documents within it.
Syntax
public class lotus.notes.View extends NotesBasei
Containmentt
Contained by:
Click here to see this topic
lotus.notes.Database
Click here to see this topic
Contains:
Click here to see this topic
lotus.notes.Document
Click here to see this topic
Click here to see this topic
lotus.notes.DateTime
Click here to see this topic
Click here to see this topic
lotus.notes.ViewColumn
Click here to see this topic
Properties
Click here to see this topic
Aliaseso
Click here to see this topic
through getAliases
Click here to see this topic
Columns
Click here to see this topic
through getColumnss
Click here to see this topic
Createdt
Click here to see this topic
through getCreated.
Click here to see this topic
IsAutoUpdate
Click here to see this topic
through isAutoUpdate and setAutoUpdate
Click here to see this topic
sCalendarn
Click here to see this topic
through isCalendari
Click here to see this topic
sDefaultView
Click here to see this topic
through isDefaultView
Click here to see this topic
sFolder
Click here to see this topic
through isFoldere
Click here to see this topic
IsProtectReaders
Click here to see this topic
through isProtectReaders and setProtectReaders
Click here to see this topic
LastModified
Click here to see this topic
through getLastModified
Click here to see this topic
Name
Click here to see this topic
through getName
Click here to see this topic
Parent
Click here to see this topic
through getParent
Click here to see this topic
Readers
Click here to see this topic
through getReaders and setReaders
Click here to see this topic
UniversalID
Click here to see this topic
through getUniversal
Methods
Click here to see this topic
lear
Click here to see this topic
Click here to see this topic
Search
Click here to see this topic
Click here to see this topic
getAllDocumentsByKey
Click here to see this topic
Click here to see this topic
etChild
Click here to see this topic
Click here to see this topic
etDocumentByKey
Click here to see this topic
Click here to see this topic
etFirstDocumentr
Click here to see this topic
Click here to see this topic
etLastDocument
Click here to see this topic
Click here to see this topic
etNextDocument
Click here to see this topic
Click here to see this topic
etNextSibling
Click here to see this topic
Click here to see this topic
etNthDocument
Click here to see this topic
Click here to see this topic
etParentDocument
Click here to see this topic
Click here to see this topic
etPrevDocument
Click here to see this topic
Click here to see this topic
etPrevSibling
Click here to see this topic
Click here to see this topic
efresh
Click here to see this topic
Click here to see this topic
emove
Click here to see this topic
Access
You access a view or folder through the lotus.notes.Database object that contains it. There are two ways:
To access a view or folder when you know its name or synonym, use
Click here to see this topic
etView
Click here to see this topic
To access all the views and folders in a database, use
Click here to see this topic
Views
Click here to see this topic
Both options return lotus.notes.View objects that represent public view(s) and/or folder(s) in the database. If a program runs on a workstation, the lotus.notes.View objects may also represent personal views and folders.
To access a view or folder when you have a document that was retrieved from the view or folder, use the
Click here to see this topic
ParentView property
Click here to see this topic
in lotus.notes.Document.C
Usageo
Both i
Click here to see this topic
lotus.notes.DocumentCollection
Click here to see this topic
and lotus.notes.View objects provide access to documents within a database. Use a lotus.notes.View object if:
There is a view or folder in the database that contains all the documents you want to search.o
You need to navigate through the documents' response hierarchies.e
You want to access documents as quickly as possible.
You want to find a document by its key in a view.
You want to access documents in sorted order.
Views are the more efficient means of accessing documents because they are already indexed by the database itself.
Accessing documents in the view or folderc
To access documents in a view or folder, there are three places to start:
The beginning -- use the getFirstDocument method
The middle -- use the getNextDocument, getNthDocument, or getDocumentByKey method
The end -- use the getLastDocument methode
Click here to see this topic
See examples
See related topics
Click here to see this topic
Compiling and running a Java program
Click here to see this topic
k* =
D{_es
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. The number of actions logged so far.
Defined in
Click here to see this topic
lotus.notes.Log
Click here to see this topic
Data typeo
Syntax
public int getNumActions()
throws NotesException
Click here to see this topic
See examples
Click here to see this topic
See related topics
Click here to see this topic
IsLogActions propertys
Click here to see this topic
Click here to see this topic
logAction method
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. The number of errors logged so far.
Defined in
Click here to see this topic
lotus.notes.Log
Click here to see this topic
Data type
Syntax
public int getNumErrors()
throws NotesExceptiont
UsageL
The NumErrors property is not incremented until after logErrors is called. To get the correct count at the time of a call to logErrors, increment getNumErrors by 1.
Click here to see this topic
See examples
Click here to see this topic
See related topics
Click here to see this topic
IsLogErrors property
Click here to see this topic
Click here to see this topic
logError method
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. If an embedded object has been loaded into memory, returns the OLE handle (IUnknown or IDispatch handle). If the OLE object supports OLE Automation, you can invoke the methods and properties of the object using the handle.o
Defined in
Click here to see this topic
lotus.notes.EmbeddedObject
Click here to see this topic
Data type
inte
Syntax
public int getObject()
throws NotesException
Usage
This property may or may not return a valid OLE handle for object links, depending upon the application used to create the object link.
See related topics
Click here to see this topic
activate method
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Opens the agent log for the current agent.
Defined in
Click here to see this topic
lotus.notes.Log:
Click here to see this topic
Syntax
public void openAgentLog()
throws NotesException
Usage
This method stores output in the log for the current agent and fails if the program is not running as an agent. To display an agent log, select the agent and choose Agent - Log.
Click here to see this topic
See examples
Click here to see this topic
See related topics
Click here to see this topic
lotus.notes.Agent class
Click here to see this topic
Click here to see this topic
Making a Notes log
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Given a server name and a replica ID, opens the specified database, if it exists.
Defined in
Click here to see this topic
lotus.notes.DbDirectory"
Click here to see this topic
Syntax
public lotus.notes.Database OpenDatabaseByReplicaID(String rid)
throws NotesException
Parameters
String rid
The replica ID of the database that you want to open.
Return value
lotus.notes.Database
The opened database.
Click here to see this topic
See examples
See related topics
Click here to see this topic
getURLDatabase method
Click here to see this topic
Click here to see this topic
openDatabase method
Click here to see this topic
Click here to see this topic
openDatabaseIfModified method
Click here to see this topic
Click here to see this topic
openMailDatabase method
Click here to see this topic
Click here to see this topic
ReplicaID property
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Starts logging to a specified file. This method returns an error if you call it on a server.
Defined in
Click here to see this topic
lotus.notes.Log
Click here to see this topic
Syntax
public void openFileLog(String filepath)
throws NotesException
Parameter
String filepath
The path and file name of the log file. If the file does not exist, the method creates it for you. If a directory in the path does not exist, the method raises an error.
Usage
To write over an existing log file, you must set the
Click here to see this topic
IsOverwriteFile property
Click here to see this topic
to true before calling openFileLog.
Logging actions and errors
For information on how actions and errors get logged to a database log, see the
Click here to see this topic
ogAction
Click here to see this topic
and
Click here to see this topic
ogError
Click here to see this topic
methods.
Click here to see this topic
See examples
Click here to see this topic
See related topics
Click here to see this topic
IsOverwriteFile property
Click here to see this topic
Click here to see this topic
Making a Notes log
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Given a date, opens the specified database if it has been modified since that date.
Defined in
Click here to see this topic
lotus.notes.DbDirectory
Click here to see this topic
Syntax
public lotus.notes.Database OpenIfModified(String dbfile, lotus.notes.DateTime date)
throws NotesException
Parameters
String dbfile
The file name of the database.
lotus.notes.DateTime dateo
A cutoff date. If one or more documents in the database has been modified since this date, the database is opened; if not, it is not opened.
Return value
lotus.notes.Database
The opened database.
Click here to see this topic
See examples
See related topics
Click here to see this topic
getURLDatabase method
Click here to see this topic
Click here to see this topic
lotus.notes.DateTime class
Click here to see this topic
Click here to see this topic
openDatabaseByReplicaID method
Click here to see this topic
Click here to see this topic
openMailDatabase method
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Opens a new mail memo for logging. The memo is mailed when the log's close method is called, or when the object is deleted.
Defined in
Click here to see this topic
lotus.notes.Log
Click here to see this topic
Syntax
public void openMailLog(java.util.Vector recipients, String subject)
throws NotesException
Parameters
java.util.Vector recipients\
The recipients of the mail memo. Each element is an object of type java.lang.String.
String subject
The subject of the mail memo.M
Usagea
When you call this method, Notes opens the current user's mail database, as specified in the Address Book, and uses this database to create and send the mail memo. The memo is not saved to the database.
Logging actions and errors
For information on how actions and errors get logged to a mail log, see the
Click here to see this topic
ogAction
Click here to see this topic
and
Click here to see this topic
ogError
Click here to see this topic
methods.
Click here to see this topic
See examples
Click here to see this topic
See related topics
Click here to see this topic
Making a Notes log
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Assigns a database to the current user's mail database and opens the database.
Defined in
Click here to see this topic
lotus.notes.DbDirectory
Click here to see this topic
Syntax
static public lotus.notes.Database openMailDatabase(lotus.notes.Session session)
throws NotesException
Parameters
lotus.notes.Session session
The current session.
Return value
lotus.notes.Database
The opened database.
Usagev
For a program to use this method, it must run either on a workstation or on the agent owner's mail server. Otherwise, it raises an error, since programs running on servers cannot access databases on other servers.
If the program runs on a workstation, OpenMailDatabase finds the current user's mail server and database in the notes.ini (or Notes Preferences) file.
If the program runs on a server, the current user is considered to be the last person who modified the agent (the agent's owner), and OpenMailDatabase finds user's mail server and database in the Public Address Book on the server.
Click here to see this topic
See examples
See related topics
Click here to see this topic
getURLDatabase method
Click here to see this topic
Click here to see this topic
openDatabase method
Click here to see this topic
Click here to see this topic
openDatabaseByReplicaID method
Click here to see this topic
Click here to see this topic
openDatabaseIfModified methodu
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Opens a specified Notes database for logging.
Defined in
Click here to see this topic
lotus.notes.Logh
Click here to see this topic
Syntax
public void openNotesLog(String server, String database)
throws NotesException
Parameters
String servern
The server on which the database log resides. Use null or an empty string ("") to indicate the current computer: a local database if the agent runs on a workstation; a database on that server if the agent runs on a server.
String database
The path and file name of the database.c
Usaget
One document is created in the database for each error or action that you log. Each document contains the following items:
Item
Y" 5P
Contents
Form
"Log Entry"h
A$PROGNAME
The ProgramName property
A$LOGTIME
The date and time that the error or action is logged
A$USER
The user of the script at the time the error or action is logged
A$LOGTYPEt
"Error" or "Action"
A$ACTION
A description of the action (actions only)
A$ERRCODE
The error code (errors only)
A$ERRMSG
Y" 5@
A description of the error (errors only)
The StdR4AgentLog template
The StdR4AgentLog template (ALOG4.NTF) is designed to display the action and error documents that lotus.notes.Log creates. If the database you specify inherits its design from this template, you can use the database's main view to see each of the items listed above. Several agents can log to the same server and database
the database categorizes each action and error according to the A$PROGNAME item.
Opening a database
An agent that runs on a server cannot open a database that's on a different server. An error is returned if you attempt to do so.p
An agent that attempts to open a database to which it does not have access returns an error. You need at least Reader access to a database in order to open it.
Logging actions and errors
For information on how actions and errors get logged to a database log, see the
Click here to see this topic
ogAction
Click here to see this topic
and t
Click here to see this topic
ogError
Click here to see this topic
methods.c
Click here to see this topic
See examples
Click here to see this topic
See related topics
Click here to see this topic
Making a Notes log
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Finds and opens the default Web Navigator database.
Defined in
Click here to see this topic
lotus.notes.Database
Click here to see this topic
Syntax
public lotus.notes.Database getURLDatabase()
throws NotesException
Return value
Click here to see this topic
lotus.notes.Database
Click here to see this topic
A lotus.notes.Database object representing the default Web Navigator database.
Click here to see this topic
See examples
Click here to see this topic
See related topics
Click here to see this topic
getDocumentByURL method
Click here to see this topic
Click here to see this topic
getURLHeaderInfo method
Click here to see this topic
Click here to see this topic
openDatabase method
Click here to see this topic
Click here to see this topic
openDatabaseByReplicaID method
Click here to see this topic
Click here to see this topic
openDatabaseIfModified method6
Click here to see this topic
Click here to see this topic
openMailDatabase method
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Opens a database. A database must be open for a script to access its properties and methods.
Defined in
Click here to see this topic
lotus.notes.DbDirectoryt
Click here to see this topic
Syntax
public lotus.notes.Database openDatabase(String dbfile)
throws NotesExceptione
public lotus.notes.Database openDatabase(String dbfile, boolean failover)
throws NotesExceptionf
Parameters
String dbfile
The file name of the database to open.
boolean failover
If true and the database cannot be opened on the current server, an attempt is made to open it on another server in the cluster (if there is a cluster). The object's Server and FilePath properties reflect the server that the database is opened on.g
Return value
lotus.notes.Database
The opened database.
Access level to a database
A program needs at least Reader access to a database to call openDatabase. An error is returned if the program does not have access.
Click here to see this topic
See examples
See related topics
Click here to see this topic
getURLDatabase method)
Click here to see this topic
Click here to see this topic
openDatabaseByReplicaID method
Click here to see this topic
Click here to see this topic
openDatabaseIfModified method
Click here to see this topic
Click here to see this topic
openMailDatabase methoda
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. The organization component of a hierarchical name (O=), or null if the property is undefined.
Defined in
Click here to see this topic
lotus.notes.Name
class
Click here to see this topic
Data type
String
Syntax
public String getOrganization()
throws NotesExceptiono
Click here to see this topic
See examples
Click here to see this topic
See related topics
Click here to see this topic
Common property
Click here to see this topic
Click here to see this topic
Country property
Click here to see this topic
Click here to see this topic
Keyword property
Click here to see this topic
Click here to see this topic
OrgUnit1 property
Click here to see this topic
Click here to see this topic
OrgUnit2 property
Click here to see this topic
Click here to see this topic
OrgUnit3 property
Click here to see this topic
Click here to see this topic
OrgUnit4 property
Click here to see this topic
V\W4s
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. The first organizational unit of a hierarchical name (OU=), or null if the property is undefined.
Defined in
Click here to see this topic
lotus.notes.Name
class
Click here to see this topic
Data type
String
Syntax
public String getOrgUnit1()
throws NotesExceptiono
Click here to see this topic
See examples
Click here to see this topic
See related topics
Click here to see this topic
Common property
Click here to see this topic
Click here to see this topic
Country property
Click here to see this topic
Click here to see this topic
Keyword property
Click here to see this topic
Click here to see this topic
Organization propertym
Click here to see this topic
Click here to see this topic
OrgUnit2 property
Click here to see this topic
Click here to see this topic
OrgUnit3 property
Click here to see this topic
Click here to see this topic
OrgUnit4 property
Click here to see this topic
V\W4s
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. The second organizational unit of a hierarchical name (OU=), or null if the property is undefined.
Defined in
Click here to see this topic
lotus.notes.Name
class
Click here to see this topic
Data type"
String
Syntax
public String getOrgUnit2()
throws NotesExceptiona
Click here to see this topic
See examples
Click here to see this topic
See related topics
Click here to see this topic
Common property
Click here to see this topic
Click here to see this topic
Country property
Click here to see this topic
Click here to see this topic
Keyword property
Click here to see this topic
Click here to see this topic
Organization propertya
Click here to see this topic
Click here to see this topic
OrgUnit1 property
Click here to see this topic
Click here to see this topic
OrgUnit3 property
Click here to see this topic
Click here to see this topic
OrgUnit4 property
Click here to see this topic
V\W4s
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. The third organizational unit of a hierarchical name (OU=), or null if the property is undefined.
Defined in
Click here to see this topic
lotus.notes.Name
class
Click here to see this topic
Data type
String
Syntax
public String getOrgUnit3()
throws NotesExceptiono
Click here to see this topic
See examples
Click here to see this topic
See related topics
Click here to see this topic
Common property
Click here to see this topic
Click here to see this topic
Country property
Click here to see this topic
Click here to see this topic
Keyword property
Click here to see this topic
Click here to see this topic
Organization propertym
Click here to see this topic
Click here to see this topic
OrgUnit1 property
Click here to see this topic
Click here to see this topic
OrgUnit2 property
Click here to see this topic
Click here to see this topic
OrgUnit4 property
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. The fourth organizational unit of a hierarchical name (OU=), or null if the property is undefined.
Defined in
Click here to see this topic
lotus.notes.Name
class
Click here to see this topic
Data type
String
Syntax
public String getOrgUnit4()
throws NotesException3
Click here to see this topic
See examples
Click here to see this topic
See related topics
Click here to see this topic
Common property
Click here to see this topic
Click here to see this topic
Country property
Click here to see this topic
Click here to see this topic
Keyword property
Click here to see this topic
Click here to see this topic
Organization propertyu
Click here to see this topic
Click here to see this topic
OrgUnit1 property
Click here to see this topic
Click here to see this topic
OrgUnit2 property
Click here to see this topic
Click here to see this topic
OrgUnit3 property
Click here to see this topic
V\W4s
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-Write. The organizational unit to use when creating ID files.
Defined in
Click here to see this topic
lotus.n
otes.Registration classn
Click here to see this topic
Data types
String
Syntax
public String getOrgUnit()
throws NotesException
public void setOrgUnit(String unit)
throws NotesExceptionc
Click here to see this topic
See examples
See related topics
Click here to see this topic
CertifierIDFile property
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-Write. For a log that records to a file, indicates if the log should write over the existing file or append to it. This property has no effect on logs that record to a mail message or database.
Defined in
Click here to see this topic
lotus.notes.Log;
Click here to see this topic
Data type
boolean
Syntax
public boolean isOverwriteFile()
throws NotesException
public void setOverwriteFile(boolean flag)
throws NotesException
Legal values
true writes over the existing log file
false (default) appends to the existing log file
Usage;
To write over an existing log file, you must set this property to true before calling the openFileLog method.
Click here to see this topic
See examples
Click here to see this topic
See related topics
Click here to see this topic
openFileLog method
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. The name of the person who last modified and saved an agent (the agent's owner).a
Defined in
Click here to see this topic
lotus.notes.Agentl
Click here to see this topic
Data type
Click here to see this topic
lotus.notes.Name
Click here to see this topic
Syntax
public String getOwner()
throws NotesException
Usage
If the owner's name is hierarchical, this property returns the fully distinguished name.
Click here to see this topic
See examples
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. The database that contains a document.o
Defined in
Click here to see this topic
lotus.notes.Document
Click here to see this topic
Data type
Click here to see this topic
lotus.notes.Database
Click here to see this topic
Syntax
public lotus.notes.Database getParentDatabase()
throws NotesExceptionk
Click here to see this topic
See examples
See related topics
Click here to see this topic
ParentView property
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. The universal ID of a document's parent, if the document is a response. Returns an empty string ("") if a document doesn't have a parent.
Defined in
Click here to see this topic
lotus.notes.Document
Click here to see this topic
Data type
Object of type java.lang.String
Syntax
public String getParentDocumentUNID()
throws NotesException
Usage
When used in conjunction with the GetDocumentByUNID method in lotus.notes.Database, the ParentDocumentUNID property allows you to find the parent document for any document.
For more information on universal IDs, see the UniversalID property.
Click here to see this topic
See examples
See related topics
Click here to see this topic
getDocumentByUNID method
Click here to see this topic
Click here to see this topic
IsResponse propertyS
Click here to see this topic
Click here to see this topic
UniversalID property
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. The view from which a document was retrieved, if any. If the document was retrieved directly from the database or a document collection, returns null.
Defined in
Click here to see this topic
lotus.notes.Document
Click here to see this topic
Data type
Click here to see this topic
lotus.notes.View
Click here to see this topic
Syntax
public lotus.notes.View getParentView()
throws NotesException
Click here to see this topic
See examples
See related topics
Click here to see this topic
ParentDatabase propertyO
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. The access control list that contains an entry.
Defined in
Click here to see this topic
lotus.notes.ACLEntry
Click here to see this topic
Data typea
Click here to see this topic
lotus.notes.ACL
Click here to see this topic
Syntax
public lotus.notes.ACL getParent()
throws NotesException
Click here to see this topic
See examples
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. The database that owns an ACL.
Defined in
Click here to see this topic
lotus.notes.ACL
Click here to see this topic
Data typei
Click here to see this topic
lotus.notes.Database
Click here to see this topic
Syntax
public lotus.notes.Database getParent()
throws NotesException
Click here to see this topic
See examples
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. The database that contains an agent.
Defined in
Click here to see this topic
lotus.notes.Agent
Click here to see this topic
Data typer
Click here to see this topic
lotus.notes.Database
Click here to see this topic
Syntax
public lotus.notes.Database getParent()
throws NotesExceptione
Click here to see this topic
See examples
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. The database that contains a document collection.
Defined in
Click here to see this topic
lotus.notes.DocumentCollection
Click here to see this topic
Data type
Click here to see this topic
lotus.notes.Database
Click here to see this topic
Syntax
public lotus.notes.Database getParent()
throws NotesExceptionB
Click here to see this topic
See examples
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. The Notes session that contains a database.
Defined in
Click here to see this topic
lotus.notes.Database
Click here to see this topic
Data type
Click here to see this topic
lotus.notes.Session
Click here to see this topic
Syntax
public lotus.notes.Session getParent()
throws NotesException
Click here to see this topic
See examples
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. The document that contains an item.
Defined in
Click here to see this topic
lotus.notes.Item
Click here to see this topic
Data type
Click here to see this topic
lotus.notes.Document
Click here to see this topic
Syntax
public lotus.notes.Document getParent()
throws NotesException
Click here to see this topic
See examples
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. The rich text item that holds an object.
Defined in
Click here to see this topic
lotus.notes.EmbeddedObject
Click here to see this topic
Data type
Click here to see this topic
lotus.notes.RichTextItem
Click here to see this topic
Syntax
public lotus.notes.RichTextItem getParent()
throws NotesException
~3X@?
{z_]s
6DP'Q
uxM^2
f-G11W
;ZLre
uS*|=
V\W4s
]6VGA
}%ALh:ts
x{7qK
k* =
bF';n^s
<]Nohps
&6EJ6
Jz aos
1l8ps
6db<}
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. The database to which a view belongs.
Defined in
Click here to see this topic
lotus.notes.View
Click here to see this topic
Data type
Click here to see this topic
lotus.notes.Database
Click here to see this topic
Syntax
public lotus.notes.Database getParent()
throws NotesExceptione
Click here to see this topic
See examples
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. The percent of a database's total size that is occupied by real data (and not empty space).
Defined in
Click here to see this topic
lotus.notes.Database
Click here to see this topic
Data type
double
Syntax
public double getPercentUsed()
throws NotesException
Usage
Compacting a database removes empty space in the database file.
Click here to see this topic
See examples
See related topics
Click here to see this topic
compact method
Click here to see this topic
Click here to see this topic
Size property
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. The name of the platform containing the local Notes directory.
Defined in
Click here to see this topic
lotus.notes.Session
Click here to see this topic
Data type
String
Syntax
public String getPlatform()
throws NotesExceptiont
Legal Values
"Macintosh"
Macintosh
"MS-DOS"
MS-DOS
"Netware"
NetWare
"OS/2v1"
OS/2
16-bit
"OS/2v2"
OS/2 32-bit
"Windows/16"
Windows 16-bit
"Windows/32"
Windows 32-bit
"UNIX"
UNIX
(Sun
v, SCO
, HP-UX
v, AIX
Click here to see this topic
See examples
Click here to see this topic
See related topics
Click here to see this topic
Accessing session properties
Click here to see this topic
Click here to see this topic
NotesVersion property
Click here to see this topic
x{7qK
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. The string that denotes PM time, for example, "PM" in English.
Defined in
Click here to see this topic
lotus.notes.International Class
Click here to see this topic
Data type
Object of java.lang.String
Syntax
public String getPMString()
throws NotesException
Click here to see this topic
See examples
Click here to see this topic
See related topics
Click here to see this topic
Accessing international settings
Click here to see this topic
Click here to see this topic
AMString property
Click here to see this topic
Click here to see this topic
IsTime24Hour propertyE
Click here to see this topic
Click here to see this topic
TimeSep property
Click here to see this topic
Click here to see this topic
TimeZone property
Click here to see this topic
}%ALh:ts
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. The position of a column in its view. Columns are numbered from left to right, starting with 1.
Defined in
Click here to see this topic
lotus.notes.ViewColumn
Click here to see this topic
Data type
Syntax
public int getPosition()
throws NotesException
Usage
The Columns property in lotus.notes.View returns an array of lotus.notes.ViewColumn objects. The array is zero-based, so the first element in the array is at index 0 and contains the lotus.notes.ViewColumn at Position 1. The second element in the array is at index 1 and contains the lotus.notes.ViewColumn at Position 2, and so on. Remember to add one to the array index to get the correct Position value.
Click here to see this topic
See examples
See related topics
Click here to see this topic
Columns property
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. The private management domain name (PRMD) of the name, or null if the property is undefined.
Defined in
Click here to see this topic
lotus.notes.Name
class
Click here to see this topic
Data type
String
Syntax
public String getPRMD()
throws NotesException
Click here to see this topic
See examples
Click here to see this topic
See related topics
Click here to see this topic
ADMD property
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-Write. The name that identifies the agent whose actions and errors you're logging. The name is the same as the name specified with createLog.
Defined in
Click here to see this topic
lotus.notes.Loge
Click here to see this topic
Data typen
Object of type java.lang.Stringa
Syntax
public String getProgramName()
throws NotesException
public void setProgramName(String name)
throws NotesException
Click here to see this topic
See examples
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-write. Protects $Readers items from being overwritten by replication.
Defined in
Click here to see this topic
lotus.notes.Form
Click here to see this topic
Data typee
booleanT
Syntax
public boolean isProtectReaders()
throws NotesExceptionU
public void setProtectReaders(boolean flag)
throws NotesException
Legal values
True
The items are protected.
False
The items are not protected.
Click here to see this topic
See examples
See related topics
Click here to see this topic
Readers property
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-write. Protects $Readers items from being overwritten by replication.
Defined in
Click here to see this topic
lotus.notes.View class
Click here to see this topic
Data typee
boolean
Syntax
public boolean isProtectReaders()
throws NotesException
public void setProtectReaders(boolean flag)
throws NotesExceptionn
Legal values
True
The items are protected.
False
The items are not protected.
Click here to see this topic
See examples
See related topics
Click here to see this topic
Readers property
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-write. Protects $FormUsers items from being overwritten by replication.
Defined in
Click here to see this topic
lotus.notes.Form
Click here to see this topic
Data type
boolean
Syntax
public boolean isProtectUsers()
throws NotesException
public void setProtectUsers(boolean flag)
throws NotesExceptions
Legal values
True
The items are protected.
Falsee
The items are not protected.
Click here to see this topic
See examples
See related topics
Click here to see this topic
FormUsers property
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Adds all the documents in the collection to the specified folder. If the folder does not exist in the document's database, it is created.
Defined in
Click here to see this topic
lotus.notes.DocumentCollection
Click here to see this topic
Syntax
public void putAllInFolder(String folderName)
throws NotesException
Parameter
String folderName
The name of the folder in which to place the documents. The folder may be personal if the script is running on the workstation. If the folder is within another folder, specify a path to it, separating folder names with backward slashes, for example, "Vehicles\Bikes".a
Usage
If a document is already inside the folder you specify, PutAllInFolder does nothing for that document. If you specify a path to a folder, and none of the folders exist, the method creates all of them for you. For example:
doc.PutAllInFolder( "Vehicles\\Bikes" );
If neither Vehicles nor Bikes exists, PutAllInFolder creates both, placing the Bikes folder inside the Vehicles folder.
Click here to see this topic
See examples
See related topics
Click here to see this topic
putInFolder method
Click here to see this topic
Click here to see this topic
removeAllFromFolder method
Click here to see this topic
Click here to see this topic
removeFromFolder method
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Adds a document to the specified folder. If the folder does not exist in the document's database, it is created.
Defined in
Click here to see this topic
lotus.notes.Document
Click here to see this topic
Syntax
public void putInFolder(String name)
throws NotesException
Parameterg
String namep
The name of the folder in which to place the document. The folder may be personal if the script is running on the workstation. If the folder is within another folder, specify a path to it, separating folder names with backward slashes, for example, "Vehicles\\Bikes".
Usage
If the document is already inside the folder you specify, PutInFolder does nothing. If you specify a path to a folder, and none of the folders exists, the method creates all of them for you. For example:
doc.putInFolder( "Vehicles\\Bikes" );
If neither Vehicles nor Bikes exists, PutInFolder creates both, placing the Bikes folder inside the Vehicles folder.
This method cannot add the first document to a folder that is "Shared, Personal on first use."
Click here to see this topic
See examples
See related topics
Click here to see this topic
removeFromFolder methodv
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Returns a person's, group's, or server's current access level to a database.
Defined in
Click here to see this topic
lotus.notes.Database
Click here to see this topic
Syntax
public int queryAccess(String name)
throws NotesExceptionp
Parameters
String nameU
The name of the person, group, or server.
Return Values
Indicates the current access level from the following:
ACLLEVEL_NOACCESSb
No access
ACLLEVEL_DEPOSITOR
Depositor access
ACLLEVEL_READER
Reader access
ACLLEVEL_AUTHOR
Author accesso
ACLLEVEL_EDITORp
Editor access
ACLLEVEL_DESIGNER
Designer access
ACLLEVEL_MANAGER
Manager access
Usage
If the name you specify is not listed explicitly in the ACL, QueryAccess does the following: e
If the name is a member of a group defined in the Public Address Book and that group name is listed in the access control list, QueryAccess returns the access level of the group name.l
If the name is a member of several groups listed in the ACL, QueryAccess returns the highest access level granted to any of the groups.p
If the name is not a member of any group, QueryAccess returns the default access level.
If the name you specify is listed explicitly in the ACL and is also a member of one or more groups listed in the ACL, QueryAccess returns whichever access level is higher.
To see if a name is a member of a group, QueryAccess uses the Address Book(s) known to the computer on which the script is running. If the script is running on a workstation, QueryAccess checks the Personal Address Book on the local computer. If the script is running on a server, QueryAccess checks the Public Address Book on that server.
Click here to see this topic
See examples
See related topics
Click here to see this topic
CurrentAccessLevel property
Click here to see this topic
Click here to see this topic
grantAccess method
Click here to see this topic
Click here to see this topic
lotus.notes.ACL class6
Click here to see this topic
Click here to see this topic
lotus.notes.ACLEntry class
Click here to see this topic
Click here to see this topic
Managers propertyt
Click here to see this topic
Click here to see this topic
revokeAccess method
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. The text of the query used by an agent to select documents. In the Agent Builder, a query is defined by the searches added to the agent using the Add Search button.T
If no query is defined with the Add Search button, the Query property returns an empty string, even if the agent runs a formula that has its own SELECT statement or a script that selects specific documents.
Defined in
Click here to see this topic
lotus.notes.Agent
Click here to see this topic
Data typeP
String
Syntax
public String getQuery()
throws NotesException
Usage
Some sample results:
If an agent searches for documents that contain the word "tulip," Query returns
("tulip")m
If an agent searches for documents that contain the word tulip and were created on September 19, 1996, Query returns t
("tulip") AND ([_CreationDate] = 09/19/96)
If an agent searches for documents that use the Response form, Query returns n
(([Form]="Response"))e
If an agent searches for documents that use the Response form and contain the phrase "mustard greens" in the Subject field, Query returns
(([Form]="Response")) AND ([Subject] CONTAINS (mustard greens))s
Click here to see this topic
See examples
Click here to see this topic
See related topics
Click here to see this topic
UnprocessedDocuments property
Click here to see this topic
Click here to see this topic
unprocessedFTSearch method
Click here to see this topic
Click here to see this topic
unprocessedSearch method
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. The text of the query that produced a document collection, if the collection results from a full text or other search.r
Defined in
Click here to see this topic
lotus.notes.DocumentCollection
Click here to see this topic
Data type_
String
Syntax
public String getQuery()
throws NotesException
Usageh
For collections produced without a search (for example, using the AllDocuments property in lotus.notes.Database), this property returns an empty string ("").
Click here to see this topic
See examples
See related topics
Click here to see this topic
FTSearch methodi
Click here to see this topic
Click here to see this topic
search method
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-write. The contents of the $Readers field.t
Defined in
Click here to see this topic
lotus.notes.Form
Click here to see this topic
Data typer
Vector of type java.util.Vector whose elements are of type java.lang.String
Syntax
public java.util.Vector getReaders()
throws NotesException
public void setReaders(java.util.Vector readers)
throws NotesException
Usage
Setting this property replaces prior values.
Click here to see this topic
See examples
See related topics
Click here to see this topic
IsProtectReaders propertyk
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-write. The contents of the $Readers field associated with the view.
Defined in
Click here to see this topic
lotus.notes.View class
Click here to see this topic
Data type7
Object of type java.util.Vector whose elements are of type java.lang.String
Syntax
public java.util.Vector getReaders()
throws NotesException
public void setReaders(java.util.Vector readers)
throws NotesException
Usage
Setting this property replaces prior values.
Set the property to "" to remove all reader restrictions.
Click here to see this topic
See examples
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Recertifies an ID file.m
Defined in
Click here to see this topic
lotus.notes.Registration class
Click here to see this topic
Syntax
public boolean recertify(String idfile)
throws NotesException
public boolean recertify(String idfile, String certpw, String comment)
throws NotesException
Parameters
String idfilec
The ID file to be recertified. Specify the full path, for example, c:\notes\data\cert.id.f
String certpwc
The password for the certifier ID file.
String comment
The contents of the comment field in the address book record.s
Return value
boolean
True if the operation is successful; false otherwise.
Click here to see this topic
See examples
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Updates a view's contents with any changes that have occurred to the database since the lotus.notes.View object was created or since the last Refresh. e
Defined in
Click here to see this topic
lotus.notes.View
Click here to see this topic
Syntax
public void refresh()
throws NotesException
Usage
Navigation through a view is not normally affected by changes to the actual database, since the lotus.notes.View object is a snapshot of the view's contents at a particular time. Additions and deletions to the view that occurred since the lotus.notes.View object was created are not reflected in the lotus.notes.View object until you call refresh.4
Click here to see this topic
See examples
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Registers a new certfier ID file.
Defined in
Click here to see this topic
lotus.n
otes.Registration class
Click here to see this topic
Syntax
public boolean registerNewCertifier(String org, String idfile, String userpw)
The ID file to be registered. Specify the complete path; for example, c:\notes\data\cert.id.
String server
The name of the server containing the user's mail file.
String pw
The password for the certifier ID file.
String firstn
The user's first name.
String middle
The user's middle intital.
String certpw
The password for the certifier ID file.
String location
The contents of the location field in the address book record.
String comment
The contents of the comment field in the address book record.
String maildbpath
The path of the user's mail file relative to the mail directory; for example, mail\jones.nsf.
String forward
The forwarding domain for the user's mail file.
Return value
boolean
True if the operation is successful; false otherwise.
Click here to see this topic
See examples
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-Write. The log file to use when creating IDs.
Defined in
Click here to see this topic
lotus.n
otes.Registration class
Click here to see this topic
Data type
String
Syntax
public String getRegistrationLog()
throws NotesException
public void setRegistrationLog(String name)
throws NotesException
Click here to see this topic
See examples
Click here to see this topic
NotesLog class
Click here to see this topic
See related topics
Click here to see this topic
lotus.notes.Log class
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-Write. The server to use when creating IDs. This property is used only when the created ID is stored in the server's address book, or when a mail database is created for the new user.
Defined in
Click here to see this topic
lotus.notes.Registration class
Click here to see this topic
Data typei
String
Syntax
public String getRegistrationServer()
throws NotesExceptionr
public void setRegistrationServer(String server)
throws NotesException
Click here to see this topic
See examples
See related topics
Click here to see this topic
CertifierIDFile property
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Removes all documents in the collection from the specified folder.
Defined in
Click here to see this topic
lotus.notes.DocumentCollection
Click here to see this topic
Syntax
public void removeAllFromFolder(String foldername)
throws NotesException
Parameters
String foldername
The name of the folder from which to remove the document. The folder may be personal if the script is running on a workstation. If the folder is within another folder, specify a path to it, separating folder names with backward slashes, for example, "Vehicles\\Bikes".
Usage
The method does nothing for documents not in the folder you specify. This method does nothing if the folder you specify does not exist.D
Click here to see this topic
See examples
See related topics
Click here to see this topic
putAllInFolder methodn
Click here to see this topic
Click here to see this topic
putInFolder method
Click here to see this topic
Click here to see this topic
removeFromFolder method
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Permanently deletes all documents in a collection from a database.
Defined in
Click here to see this topic
lotus.notes.DocumentCollection
Click here to see this topic
Syntax
public void removeAll(boolean force)
throws NotesException
Parameters
boolean forcec
Boolean. If true, a document is deleted even if another user modifies the document after the script opens it. If false, a document is not deleted if another user modifies it.
Click here to see this topic
See examples
See related topics
Click here to see this topic
remove method
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Removes a document from the specified folder.t
Defined in
Click here to see this topic
lotus.notes.Document
Click here to see this topic
Syntax
public void removeFromFolder(String name)
throws NotesExceptiont
Parameter
String namee
The name of the folder from which to remove the document. The folder may be personal if the script is running on a workstation. If the folder is within another folder, specify a path to it, separating folder names with backward slashes, for example, "Vehicles\\Bikes".
Usaget
The method does nothing if the document is not in the folder you specify, or if the folder you specify does not exist.
IsSaveMessageOnSend propertySave message on sendsetSaveMessageOnSend methodProgAllH_SAVEMESSAGEONSEND_PROPERTY_JAVAContext Help FormIsSaveMessageOnSend property
Text property\in Lotus.Notes.Local.DateRangesetText method\in Lotus.Notes.Local.DateRangeProgAllH_TEXT_PROPERTY_RANG_JAVAContext Help FormText property
Title property\in lotus.notes.DatabasegetTitle method\in lotus.notes.DatabasesetTitle method\in lotus.notes.DatabaseProgAllH_TITLE_PROPERTY_DB_JAVAContext Help FormTitle property
Type property\in lotus.notes.EmbeddedObjectgetType method\in lotus.notes.EmbeddedObjectProgAllH_TYPE_PROPERTY_OBJECT_JAVAContext Help FormType property
Timelotus.notes.DateTime classDateTime classlotus.notes.DateRange classDateRange classProgStepsH_WORKING_WITH_NOTES_TIME_JAVAContext Help FormWorking with Notes time
Given the name of an item, deletes the item from a document.
Defined in
Click here to see this topic
lotus.notes.Document
Click here to see this topic
Syntax
public void removeItem(String name)
throws NotesException
Parameter
String name
The name of the item to delete from the document. If more than one item has
name
, all items with this name are deleted. If there is no item with
name,
the method does nothing.
Usagev
You can achieve the same result with the Remove method in the lotus.notes.Item class.
Remember to call Save to save your changes to a document.
Click here to see this topic
See examples
See related topics
Click here to see this topic
appendItemValue method
Click here to see this topic
Click here to see this topic
getFirstItem method
Click here to see this topic
Click here to see this topic
getItemValue method
Click here to see this topic
Click here to see this topic
hasItem method
Click here to see this topic
Click here to see this topic
replaceItemValue method
Click here to see this topic
Click here to see this topic
Values property
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Removes an entry from an access control list.p
Defined in
Click here to see this topic
lotus.notes.ACLEntry
Click here to see this topic
Syntax
public void remove()
throws NotesException
Usage
Once an entry is removed from an ACL, that person, server, or group may still access the database at the level permitted by the Default entry.
Click here to see this topic
See examples
See related topics
Click here to see this topic
revokeAccess method
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Permanently deletes an agent from a database.r
Defined in
Click here to see this topic
lotus.notes.Agentj
Click here to see this topic
Syntax
public void remove()
throws NotesException
Usagei
Once you call this method, the lotus.notes.Agent object is null and you can no longer use its methods or properties.
It is possible to use this method to delete the agent that's currently running. Use this feature with care. You must refresh the Agents view in the user interface to see that the agent has been removed.
Click here to see this topic
See examples
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Permanently deletes a database from disk.7
Defined in
Click here to see this topic
lotus.notes.Database
Click here to see this topic
Syntax
public void remove()
throws NotesException
Click here to see this topic
See examples
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Permanently deletes a document from a database.
Defined in
Click here to see this topic
lotus.notes.Document
Click here to see this topic
Syntax
public boolean remove(boolean force)
throws NotesException
Parameter
boolean forces
If True, the document is deleted even if another user modifies the document after the script opens it. If False, the document is not deleted if another user modifies it.
Return value
boolean
True
The document was successfully deleted.
Falsee
The document was not deleted, because another user modified it and the e
force
parameter is set to False.
Click here to see this topic
See examples
See related topics
Click here to see this topic
removeAll method
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Permanently deletes a form from a database.
Defined in
Click here to see this topic
lotus.notes.Form
Click here to see this topic
Syntax
public void remove()
throws NotesException
Click here to see this topic
See examples
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Permanently deletes an item from a document.
Defined in
Click here to see this topic
lotus.notes.Item
Click here to see this topic
Syntax
public void remove()
throws NotesException
Usage
After calling the Remove method, you must call the Save method in lotus.notes.Document to save the change that you made.
You can achieve the same result with the RemoveItem method in the lotus.notes.Document class.
Click here to see this topic
See examples
See related topics
Click here to see this topic
removeItem method
Click here to see this topic
Click here to see this topic
save method
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Permanently deletes an embedded object, object link, or file attachment.
Defined in
Click here to see this topic
lotus.notes.EmbeddedObject
Click here to see this topic
Syntax
public void remove()
throws NotesException
Usage
After calling the Remove method, you must call the save method in lotus.notes.Document to save the change that you made.
Click here to see this topic
See examples
See related topics
Click here to see this topic
save method
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Permanently deletes a view from a database.
Defined in
Click here to see this topic
lotus.notes.View
Click here to see this topic
Syntax
public void remove()
throws NotesException
Click here to see this topic
See examples
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Changes the name of a role.i
Defined in
Click here to see this topic
lotus.notes.ACL
Click here to see this topic
Syntax
public void renameRole(String oldName, String newName)
Parameters
String oldname
The current name of the role.
String newname
The new name you want to give to the role.
Usageo
When you rename a role, any entries in the ACL that had the old role get the new role.
Click here to see this topic
See examples
See related topics
Click here to see this topic
addRole method
Click here to see this topic
Click here to see this topic
disableRole method
Click here to see this topic
Click here to see this topic
enableRole method
Click here to see this topic
Click here to see this topic
Roles property
Click here to see this topic
Click here to see this topic
Roles property
Click here to see this topic
&6EJ6
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Creates a picture of a document and places it into a rich text item you specify. The picture is created using both the document and its form. Therefore, the form's input translation and validation formulas are executed.i
Defined in
Click here to see this topic
lotus.notes.Document
Click here to see this topic
Syntax
public boolean renderToRTItem(lotus.notes.RichTextItem rtitem)
throws NotesException
Parameterh
lotus.notes.RichTextItem rtitem
The destination for the picture.
Return value
booleanc
If true, the method was successful. If false, the method was not successful and the rich text item remains unchanged. This can happen if an input validation formula fails on the document's form.
Click here to see this topic
See examples
See related topics
Click here to see this topic
lotus.notes.RichTextItem class
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Replaces all items of the specified name with one new item, which is assigned the specified value. If the document does not contain an item with the specified name, the method creates a new item and adds it to the document.
Defined in
Click here to see this topic
lotus.notes.Document
Click here to see this topic
Syntax
public lotus.notes.Item replaceItemValue(String name, Object value)
throws NotesExceptions
Parameters
String name
String. The name of the item(s) you want to replace.
Object value
The value of the new item. The data type of the item depends upon the data type of o
value
, and does not need to match the data type of the old item.
Data type of value
Resulting lotus.notes.Item
java.lang.String
Text item containing e
valuei
java.util.Vector with java.lang.String elementsh
Text item containing each element of
valueh
integerl
Number item containing e
valuet
java.util.Vector with integer elements
Number item containing each element of
value
lotus.notes.DateTime
Date-time item containing the date-time represented by the objecta
java.util.Vector with lotus.notes.DateTime elementsa
Date-time item containing each element of
valuee
lotus.notes.Item
Item whose data type matches the lotus.notes.Item type and whose value(s) match the lotus.notes.Item value(s)t
Return value
lotus.notes.Item
The new item, which replaces all previous items that had the item name. The new item has a new value, which may be of a different data type than the old item.
Usage
The IsSummary property of the item defaults to false, which means that the item value cannot be displayed in a view or folder. You must explicitly set IsSummary to true if you want the value to be displayed in a view or folder.
Click here to see this topic
See examples
See related topics
Click here to see this topic
appendItemValue method
Click here to see this topic
Click here to see this topic
getItemValue method
Click here to see this topic
Click here to see this topic
lotus.notes.Item class
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. A 16-character combination of letters and numbers that represents the replica ID of a Notes database. Any databases with the same replica ID are replicas of one another.
Defined in
Click here to see this topic
lotus.notes.Database
Click here to see this topic
Data type
Object of type java.lang.String
Syntax
public String getReplicaID()
throws NotesException
Click here to see this topic
See examples
See related topics
Click here to see this topic
createReplica method
Click here to see this topic
Click here to see this topic
openDatabaseByReplicaID method
Click here to see this topic
Click here to see this topic
replicate method
Click here to see this topic
Click here to see this topic
Server property
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Replicates a database with its replica(s) on a given server.
Defined in
Click here to see this topic
lotus.notes.Database
Click here to see this topic
Syntax
public boolean replicate(String server)
throws NotesException
Parameter
String serverh
The name of the server with which you want to replicate. Any replicas of the current database that exist on the server will replicate.
Return value
booleane
True
The database replicated without errors.
False
The database did not successfully replicate; document replication errors occurred.
Usagei
If the server does not contain a replica of the database, an exception is thrown.b
Click here to see this topic
See examples
See related topics
Click here to see this topic
createReplica method
Click here to see this topic
Click here to see this topic
openDatabaseByReplicaID method
Click here to see this topic
Click here to see this topic
ReplicaID property
Click here to see this topic
Click here to see this topic
Server property
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Click here to see this topic
lotus.notes.Name
Click here to see this topic
object allows you to represent a Notes user or server name so that you can access the parts of the name as properties. Use
Click here to see this topic
reateName
Click here to see this topic
in NotesSession to establish the object and specify the name. If the name is in the form of a hierarchical name, it is treated as a hierarchical name; otherwise, it is treated as a flat name.
The following methods access the lotus.notes.Name properties. These methods return null for undefined properties.
Click here to see this topic
isHierarchical
Click here to see this topic
returns true if the name is hierarchical.
Click here to see this topic
getAbbreviated
Click here to see this topic
returns a String value containing the abbreviated form of a hierarchical name.
Click here to see this topic
getCanonical
Click here to see this topic
returns a String value containing the canonical form of a hierarchical name.
Click here to see this topic
getCommon
Click here to see this topic
returns a String value containing the common name (CN=) component of a hierarchical name.
Click here to see this topic
getCountry
Click here to see this topic
returns a String value containing the country (C=) component of a hierarchical name.
Click here to see this topic
getOrganization
Click here to see this topic
returns a String value containing the organization (O=) component of a hierarchical name.
Click here to see this topic
getOrgUnit1
Click here to see this topic
returns a String value containing the first organizational unit (OU=) component of a hierarchical name.
Click here to see this topic
getOrgUnit2
Click here to see this topic
returns a String value containing the second organizational unit (OU=) component of a hierarchical name.
Click here to see this topic
getOrgUnit3i
Click here to see this topic
returns a String value containing the third organizational unit (OU=) component of a hierarchical name.
Click here to see this topic
getOrgUnit4
Click here to see this topic
returns a String value containing the fourth organizational unit (OU=) component of a hierarchical name.
Click here to see this topic
getKeyword
Click here to see this topic
returns a String value containing the country\organization\organizational unit 1\organizational unit 2\organizational unit 3\organizational unit 4.
Click here to see this topic
getGeneration
Click here to see this topic
returns a String value containing the generation part of a name, for example, "Jr."
Click here to see this topic
getGiven
Click here to see this topic
returns a String value containing the given part of a name.
Click here to see this topic
getInitials
Click here to see this topic
returns a String value containing the initials part of a name.
Click here to see this topic
getSurname
Click here to see this topic
returns a String value containing the surname part of a name.
Click here to see this topic
getADMD
Click here to see this topic
returns a String value containing the administration management domain name part of a name.
Click here to see this topic
getPRMD
Click here to see this topic
returns a String value containing the private management domain name part of a name.
Click here to see this topic
See examples
Click here to see this topic
V\W4s
;ZLre
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. The immediate responses to a document.y
Defined in
Click here to see this topic
lotus.notes.Document
Click here to see this topic
Data type
Click here to see this topic
lotus.notes.DocumentCollection
Click here to see this topic
Syntax
public lotus.notes.DocumentCollection getResponses()
throws NotesException
Usaget
Each document returned is an immediate response to the first document. Responses-to-responses are not included. If the current document has no responses, the vector contains zero documents.p
Responses-to-Responses
This property returns only immediate responses to a document, but you can write a recursive sub or function to access all the descendants of a particular document. A recursive sub calls itself, the same way that a non-recursive sub calls any other sub or function.
Click here to see this topic
See examples
See related topics
Click here to see this topic
getChild method
Click here to see this topic
Click here to see this topic
getNextSibling methode
Click here to see this topic
Click here to see this topic
getParentDocument method
Click here to see this topic
Click here to see this topic
getPrevSibling methodt
Click here to see this topic
Click here to see this topic
IsResponse property
Click here to see this topic
Click here to see this topic
lotus.notes.DocumentCollection class
Click here to see this topic
Click here to see this topic
makeResponse method
Click here to see this topic
Click here to see this topic
ParentDocumentUNID property
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Removes a person, group, or server from a database access control list. This resets the access level for that person, group, or server to the Default setting for the database.h
Defined in
Click here to see this topic
lotus.notes.Database
Click here to see this topic
Syntax
public void revokeAccess(String name)
throws NotesExceptione
Parameterl
String name
The name of the person, group, or server whose access you want to revoke.s
Usageu
Revoking access is different than assigning No Access (which you can do with the GrantAccess method). When you revoke access, you remove the name from the ACL, but the person, group, or server can still access the database at the level specified for the Default. When you use the GrantAccess method to assign No Access, the name remains in the ACL, and the person, group, or server cannot access the database, regardless of the Default setting.
Errors
The name must be explicitly listed in the database ACL. If it isn't, RevokeAccess throws an exception, even if the
name
is a member of a group that is listed in the ACL.
Click here to see this topic
See examples
See related topics
Click here to see this topic
CurrentAccessLevel property
Click here to see this topic
Click here to see this topic
grantAccess method
Click here to see this topic
Click here to see this topic
lotus.notes.ACL class
Click here to see this topic
Click here to see this topic
lotus.notes.ACLEntry class
Click here to see this topic
Click here to see this topic
Managers propertyT
Click here to see this topic
Click here to see this topic
queryAccess method
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. The roles that are enabled for an entry.
Defined in
Click here to see this topic
lotus.notes.ACLEntry
Click here to see this topic
Data type
Object of type java.util.Vector whose elements are of type java.lang.String
Syntax
public java.util.Vector getRoles()
throws NotesException
Usage
Each role name is surrounded by brackets, for example, "[Project Leader]."
Click here to see this topic
See examples
See related topics
Click here to see this topic
addRole method
Click here to see this topic
Click here to see this topic
deleteRole method
Click here to see this topic
Click here to see this topic
disableRole method
Click here to see this topic
Click here to see this topic
enableRole methode
Click here to see this topic
Click here to see this topic
isRoleEnabled method
Click here to see this topic
Click here to see this topic
Roles property
Click here to see this topic
&6EJ6
Jz aos
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. All the roles defined in an access control list.
Defined in
Click here to see this topic
lotus.notes.ACLr
Click here to see this topic
Data typeo
Object of type java.util.Vector whose elements are of type java.lang.String
Syntax
public java.util.Vector getRoles()
throws NotesException
Usage
Each element in the array is the name of a role. Each role name is surrounded either by parentheses (for Notes Release 2 "privileges") or by square brackets, for example, "[Supervisor]."
Click here to see this topic
See examples
See related topics
Click here to see this topic
addRole method
Click here to see this topic
Click here to see this topic
deleteRole method
Click here to see this topic
Click here to see this topic
disableRole method
Click here to see this topic
Click here to see this topic
enableRole methode
Click here to see this topic
Click here to see this topic
isRoleEnabled method
Click here to see this topic
Click here to see this topic
renameRole methodt
Click here to see this topic
Click here to see this topic
Roles property
Click here to see this topic
&6EJ6
Jz aos
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Runs the agent.
Defined in
Click here to see this topic
lotus.notes.Agent
Click here to see this topic
Syntax
public void run()
throws NotesException
Usagee
You cannot run an agent recursively (cannot call it from itself).
The user cannot interact directly with a called agent. User output goes to the Notes log.s
Click here to see this topic
See examples
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. A document that an agent uses to store information between invocations. The agent can use the information in this document the next time the script runs.
Defined in
Click here to see this topic
lotus.notes.AgentContext
Click here to see this topic
Data type.
Click here to see this topic
lotus.notes.Document
Click here to see this topic
Syntax
public lotus.notes.Document getSavedData()
throws NotesException
Usage
The getSavedData document is created when you save an agent, and it is stored in the same database as the agent. The document replicates, but is not displayed in views.
Each time you edit and re-save an agent, its getSavedData document is deleted and a new, blank one is created. When you delete an agent, its getSavedData document is deleted.
Click here to see this topic
See examples
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-Write. Indicates if a document is saved to a database when mailed. Only applies to new documents that have not yet been saved.
Defined in
Click here to see this topic
lotus.notes.Document
Click here to see this topic
Data type
boolean
Syntax
public boolean isSaveMessageOnSend()
throws NotesException
public void setSaveMessageOnSend(boolean flag)
throws NotesException
Legal values
True
The document is saved when mailed.
False
The document is not saved when mailed.
Usage
When SaveMessageOnSend is true, the document is saved just after being mailed.
Click here to see this topic
See examples
See related topics
Click here to see this topic
createReplyMessage method
Click here to see this topic
Click here to see this topic
IsEncryptOnSend property
Click here to see this topic
Click here to see this topic
IsSignOnSend propertyi
Click here to see this topic
Click here to see this topic
save methodt
Click here to see this topic
Click here to see this topic
send methodu
Click here to see this topic
NKuls
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-write. Indicates if an item is saved to disk when the document is saved.
Defined in
Click here to see this topic
lotus.notes.Item class
Click here to see this topic
Data type
boolean
Syntax
public boolean isSaveToDisk()
throws NotesException
public void setSaveToDisk(boolean flag)
throws NotesException
Legal values
True
Default. The item is saved to disk when the document is saved.
False
The item is not saved to disk when the document is saved.
Usage
If you mark an existing item as not to be saved, it disappears from disk the next time you save the document.
Click here to see this topic
See examples
See related topics
Click here to see this topic
save method_
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Saves the changes you've made to the ACL. If you don't call Save before closing a database, the changes you've made to its ACL are lost.
Defined in
Click here to see this topic
lotus.notes.ACL
Click here to see this topic
Syntax
public void save()
throws NotesException
Click here to see this topic
See examples
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Saves changes made to the agent.
Defined in
Click here to see this topic
lotus.notes.AgentP
Click here to see this topic
Syntax
public void save()
throws NotesException
Usage
You must call Save after
Click here to see this topic
setServerName
Click here to see this topic
and b
Click here to see this topic
setEnabled
Click here to see this topic
, or the new value is lost.
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Saves any changes you have made to a document.
Defined in
Click here to see this topic
lotus.notes.Document
Click here to see this topic
Syntax
public boolean save()
throws NotesException7
public boolean save(boolean force)
throws NotesException
public boolean save(boolean force, boolean makeresponse)
throws NotesException
public boolean save(boolean force, boolean makeresponse, boolean markread)
throws NotesException
Parameters
boolean force
If true, the document is saved even if someone else edits and saves the document while the script is running. The last version of the document that was saved wins; the earlier version is discarded.
If false, and someone else edits the document while the script is running, the
makerG
esponse
argument determines what happens.
boolean makeresponse
If true, the current document becomes a response to the original document (this is what the replicator does when there's a replication conflict). If false, the save is canceled. If the t
force
parameter is true, the
maker
esponse
parameter has no effect.
boolean markread
If true, the document is marked as read. If false (default), the document is not marked as read.
Return Value
True
The document was successfully saved.
False
The document was not saved.7
Click here to see this topic
See examples
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Given selection criteria for a document, returns all documents in a database that meet the criteria.
Defined in
Click here to see this topic
lotus.notes.Database
Click here to see this topic
Syntax
public lotus.notes.DocumentCollection search(String formula,)
throws NotesExceptionL
public lotus.notes.DocumentCollection search(String formula, lotus.notes.DateTime dt)
throws NotesException
public lotus.notes.DocumentCollection search(String formula, lotus.notes.DateTime dt, int max)
throws NotesException
Parameters
String formula
A Notes @function formula that defines the selection criteria.
lotus.notes.DateTime dt
A cutoff date. The method searches only documents created or modified since the cutoff date.
int maxC
The maximum number of documents you want returned. Specify 0 to receive all matching documents.
Return value
lotus.notes.DocumentCollection
An unsorted collection of documents that match the selection criteria.
Click here to see this topic
See examples
See related topics
Click here to see this topic
FTSearch method
Click here to see this topic
Click here to see this topic
lotus.notes.DocumentCollection class
Click here to see this topic
Click here to see this topic
unprocessedSearch method
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Mails a document to the recipients you specify.
Defined in
Click here to see this topic
lotus.notes.Document
Click here to see this topic
Syntax
public void send(String recipient)
throws NotesException
public void send(java.util.Vector recipients)
throws NotesException
public void send(boolean attachform, String recipient)
throws NotesException
public void send(boolean attachform, java.util.Vector recipients)
throws NotesException
Parameters
String recipient
The recipients of the document. See below.
java.util.Vector recipients
Array of java.lang.String elements. The recipients of the document, which may include people, groups, or mail-in databases.c
Ignored if the document contains a SendTo item, in which case the document is mailed to recipients listed in SendTo.
Required if the document does not contain a SendTo item.
boolean attachform
If true, the form is stored and sent along with the document. If false, it isn't.
Usaget
There are two kinds of items that can affect the mailing of the document when you use Send:u
If the document contains additional recipient items, such as CopyTo or BlindCopyTo, Notes mails the documents to these recipients.
If the document contains items to control the routing of mail, such as DeliveryPriority, DeliveryReport, or ReturnReceipt, Notes uses these when sending the document.
The SaveMessageOnSend property controls whether the sent document is saved in the database. If SaveMessageOnSend is True and you attach the form to the document, the form is saved with the document.
Sending the form increases the size of the document, but insures that the recipient can see all of the items on the document.
The Send method automatically creates an item called $AssistMail on the sent document. The SentByAgent property uses this item to determine if a document was mailed by a script.
If a script runs on a workstation, the mailed document contains the current user's name in the From item. If a script runs on a server, the mailed document contains the server's name in the From item.
Click here to see this topic
See examples
See related topics
Click here to see this topic
IsEncryptOnSend property
Click here to see this topic
Click here to see this topic
IsSaveMessageOnSend property
Click here to see this topic
Click here to see this topic
IsSentByAgent property
Click here to see this topic
Click here to see this topic
IsSignOnSend propertya
Click here to see this topic
Click here to see this topic
Making a Notes newsletter
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. Indicates if a document was mailed by a script.
Defined in
Click here to see this topic
lotus.notes.Document
Click here to see this topic
Data typet
booleann
Syntax
public boolean isSentByAgent()
throws NotesException
Legal values
True
The document was mailed by a script.
False
The document was mailed by a person.
Usage
In agents that respond to mail messages, you can use this property to make sure that the agent is not responding to mail that was sent by another agent (or other script).
This property returns true if the document was mailed by any script, not just an agent script.
Documents sent by a script contain an item called $AssistMail whose value is set to 1. When a script uses the Send method to mail a document, the method automatically creates this item on the document.
Click here to see this topic
See examples
See related topics
Click here to see this topic
createReplyMessage method
Click here to see this topic
Click here to see this topic
send method
Click here to see this topic
NKuls
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-write. The name of the server on which an agent runs.
Defined in
Click here to see this topic
lotus.notes.Agent
Click here to see this topic
Data type
String
Syntax
public String getServerName()
throws NotesException
public void setServerName(String serverName)
throws NotesException
Usage
The value returned by getServerName depends upon whether the agent is scheduled:
If the agent is scheduled, the property returns the name of the server that the scheduled agent runs on. Since scheduled agents can only run on a single replica of a database, you designate a server name for the agent under Schedule in the Agent Builder. Therefore, the ServerName property may represent the parent database's server, or it may represent a replica's server.
If the agent is not scheduled, this property returns the name of the parent database's server. If the parent database is on a workstation, this property returns the current user name.W
You can set ServerName to the asterisk (*) to indicate that the agent can run on any server.
A null ServerName means the local workstation.
You must call
Click here to see this topic
Save
Click here to see this topic
to make any change effective.
Click here to see this topic
See examples
Click here to see this topic
See related topics
Click here to see this topic
IsOnServer property
Click here to see this topic
Click here to see this topic
ReplicaID property
Click here to see this topic
Click here to see this topic
Server propertyr
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. The name of the server where a database resides.&
Defined in
Click here to see this topic
lotus.notes.Database
Click here to see this topic
Data type
Object of type java.lang.String
Syntax
public String getServer()
throws NotesException
Usage
If the database is on a workstation, the property returns null.
Click here to see this topic
See examples
See related topics
Click here to see this topic
FileName property
Click here to see this topic
Click here to see this topic
FilePath property
Click here to see this topic
Click here to see this topic
IsOnServer property%
Click here to see this topic
Click here to see this topic
openDatabaseByReplicaID method
Click here to see this topic
Click here to see this topic
replicate method
Click here to see this topic
Click here to see this topic
ServerName property
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Sets the date component to a wildcard value, which means it matches any date. The time component is unaffected.
Defined in
Click here to see this topic
lotus.notes.DateTime
Click here to see this topic
Syntax
public void setAnyDate()
throws NotesException
Usage_
This method is useful when passing the object as an argument to other methods.
A lotus.notes.DateTime object for which you have invoked this method may not be convertible to string format.
See related topics
Click here to see this topic
setAnyTime methodl
Click here to see this topic
Click here to see this topic
setNow method
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Sets the time component to a wildcard value, which means it matches any time. The date component is unaffected.
Defined in
Click here to see this topic
lotus.notes.DateTime
Click here to see this topic
Syntax
public void setAnyTime()
throws NotesException
Usage_
This method is useful when passing the object as an argument to other methods.
A date-time object for which you have invoked this method may not be convertible to string format.
See related topics
Click here to see this topic
setAnyDate method
Click here to see this topic
Click here to see this topic
setNow method
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Sets the value of a string or numeric environment variable.
Defined in
Click here to see this topic
lotus.notes.Session
Click here to see this topic
Syntax
public void setEnvironmentVar(String vname, Object value)
throws NotesException
public void setEnvironmentVar(String vname, Object value, boolean issystem)
throws NotesExceptionw
Parameters
String vname
The name of the environment variable to set.
Object value
The value of the environment variable. Date values are converted to strings.
boolean issystem
If true, no dollar sign character ("$") is prepended to the variable name.
Usage
If an environment variable called
vnameo
already exists, it gets the new value. Otherwise, a new environment variable is added to the NOTES.INI (or Notes Preferences) file.
SetEnvironmentVar prepends a dollar sign character ("$") to the name before setting the value of the environment variable, unless you specify
issystem
as false or have already included a "$" as the first character of the name
When you examine the environment variable in the NOTES.INI (or Notes Preferences) file, you see the "$" character. When retrieving environment variables with the getEnvironmentString or getEnvironmentValue methods, you have the option of including or omitting the "$" from the variable name.b
The environment variable is set in the local notes.ini (or Notes Preferences) file.
Click here to see this topic
See examples
Click here to see this topic
See related topics
Click here to see this topic
getEnvironmentString method
Click here to see this topic
Click here to see this topic
getEnvironmentValue method
Click here to see this topic
Click here to see this topic
Using environment variables
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Sets the value of a date-time to now (today's date and current time).
Defined in
Click here to see this topic
lotus.notes.DateTime
Click here to see this topic
Syntax
public void setNow()
throws NotesException
Usage
This method works by taking a snapshot of the current date-time at the moment that the method is executed. After the method executes, the value of the lotus.notes.DateTime object does
not
update itself to always reflect the current date-time. Its value only changes if you change it explicitly.
Click here to see this topic
See examples
Click here to see this topic
See related topics
Click here to see this topic
setAnyDate method
Click here to see this topic
Click here to see this topic
setAnyTime methodg
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. The name of the person who created the signature, if a document is signed.
Defined in
Click here to see this topic
lotus.notes.Document
Click here to see this topic
Data type
Object of type java.lang.String
Syntax
public String getSigner()
throws NotesException
Usage
If a document is not signed, returns null.
Click here to see this topic
See examples
See related topics
Click here to see this topic
IsSigned property
Click here to see this topic
Click here to see this topic
IsSignOnSend property
Click here to see this topic
Click here to see this topic
sign method
Click here to see this topic
Click here to see this topic
Verifier propertyX
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-Write. Indicates if a document is signed when mailed.
Defined in
Click here to see this topic
lotus.notes.Document
Click here to see this topic
Data type
boolean
Syntax
public boolean isSignOnSend()
throws NotesException
public void setSignOnSend(boolean flag)
throws NotesException2
Legal values
True
The document is signed when mailed.y
Falsee
The document is not signed when mailed.
Click here to see this topic
See examples
See related topics
Click here to see this topic
IsEncryptOnSend property
Click here to see this topic
Click here to see this topic
IsSaveMessageOnSend property
Click here to see this topic
Click here to see this topic
IsSigned property
Click here to see this topic
Click here to see this topic
sign method.
Click here to see this topic
Click here to see this topic
Signer property
Click here to see this topic
Click here to see this topic
Verifier property
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Signs a document.
Defined in
Click here to see this topic
lotus.notes.Document
Click here to see this topic
Syntax
public void sign()
throws NotesException
Usage
If you want the signature to be saved, you must call the Save method after signing the document.
If the script is running on a server, this method has no effect.
Click here to see this topic
See examples
See related topics
Click here to see this topic
IsSigned property
Click here to see this topic
Click here to see this topic
IsSignOnSend property
Click here to see this topic
Click here to see this topic
Signer propertya
Click here to see this topic
Click here to see this topic
Verifier property
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-write. The size quota of a database, in kilobytes.s
Defined in
Click here to see this topic
lotus.notes.Database
Click here to see this topic
Data type
Syntax
public int getSizeQuota()
throws NotesException
public void setSizeQuota(int quota)
throws NotesException
Usage
The size quota for a database specifies the amount of disk space that the server administrator is willing to provide for the database. Therefore, the SizeQuota property can only be set by a script that has administrator access to the server on which the database resides. The size quota is
the same as the size limit that a user specifies when creating a new database.
If there is no size quota for the database, this property returns 0.
Click here to see this topic
See examples
See related topics
Click here to see this topic
compact method
Click here to see this topic
Click here to see this topic
PercentUsed property
Click here to see this topic
Click here to see this topic
Size property
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. The size of a database, in bytes.
Defined in
Click here to see this topic
lotus.notes.Database
Click here to see this topic
Data type
double
Syntax
public double getSize(()
throws NotesException
Click here to see this topic
See examples
See related topics
Click here to see this topic
compact method
Click here to see this topic
Click here to see this topic
PercentUsed property
Click here to see this topic
Click here to see this topic
SizeQuota property
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. The size of a document in bytes, which includes the size of any file attachments on the document.
Defined in
Click here to see this topic
lotus.notes.Document
Click here to see this topic
Data type
inte
Syntax
public int getSize()
throws NotesException
Click here to see this topic
See examples
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only.
If the lotus.notes.EmbeddedObject is an embedded object or object link, this property returns the internal name that Notes uses to refer to the source document.
If the lotus.notes.EmbeddedObject is a file attachment, this property returns the file name of the original file.
Defined in
Click here to see this topic
lotus.notes.EmbeddedObject
Click here to see this topic
Data type
Object of type java.lang.Stringe
Syntax
public String getSource()
throws NotesException
Usages
If the lotus.notes.EmbeddedObject is a file attachment returned from the EmbedObject method in lotus.notes.RichTextItem, the Source property returns the full path and file name of the attachment. If the lotus.notes.EmbeddedObject is a file attachment obtained from another property or method, the Source property returns only the file name of the attachment.
Click here to see this topic
See examples
See related topics
Click here to see this topic
ClassName property
Click here to see this topic
Click here to see this topic
embedObject method
Click here to see this topic
Click here to see this topic
Name property
Click here to see this topic
Click here to see this topic
Type property
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Replaces the value of a specified name in all documents in a collection.
Defined in
Click here to see this topic
lotus.notes.DocumentCollection
Click here to see this topic
Syntax
public void stampAll(String itemname, Object value)
throws NotesExceptione
Parameters
String itemnameh
The name of the item.p
Object value
A value appropriate for the item type.
Usager
If the item does not exist, it is created.
The item values are immediately written to the back-end documents. You do not have to use the Save method of lotus.notes.Document after StampAll. However, any documents modified by your script must be saved
before
calling StampAll.
This method modifies the on-disk version of the documents, so save the document you want to modify before using StampAll.
Click here to see this topic
See examples
See related topics
Click here to see this topic
save method
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-write. The starting date-time of a range.
Defined in
Click here to see this topic
lotus.notes.DateRange
Click here to see this topic
Data typee
Click here to see this topic
lotus.notes.DateTime
Click here to see this topic
Syntax
public lotus.notes.DateTime getStartDateTime()
throws NotesException
public setStartDateTime(lotus.notes.DateTime t)
throws NotesExceptionn
Usage
Modifying the lotus.notes.DateTime object that StartDateTime is based on implicitly modifies StartDateTime.o
Click here to see this topic
See examples
Click here to see this topic
See related topics
Click here to see this topic
createDateRange method
Click here to see this topic
Click here to see this topic
EndDateTime property
Click here to see this topic
Click here to see this topic
freeTimeSearch method
Click here to see this topic
Click here to see this topic
Text property
Click here to see this topic
Click here to see this topic
Working with Notes time
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-Write. Indicates whether the ID file is stored in the server address book.
Defined in
Click here to see this topic
lotus.notes.Registration class
Click here to see this topic
Data type
booleani
Syntax
public boolean getStoreIDInAddressBook()
throws NotesException
public void setStoreIDInAddressBook(boolean flag)
throws NotesExceptiono
Legal Values
True
The ID is stored in the address book.&
Falsei
The ID is not stored in the address book.
Click here to see this topic
See examples
See related topics
Click here to see this topic
UpdateAddressbook property
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-Write. Strikethrough rich text attribute.
Defined in
Click here to see this topic
lotus.notes.
RichTextStylet
Click here to see this topic
Data typec
Syntax
public int getStrikeThrough()
throws NotesException
public void setStrikeThrough(int value)
throws NotesException
Legal values
YES for strikethroughe
NO for non-strikethrough
STYLE_NO_CHANGE to maintain the previous state
Click here to see this topic
See examples
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-Write. For a newsletter document created using the
Click here to see this topic
formatMsgWithDoclinks method
Click here to see this topic
, indicates the name of the item on a newsletter's documents which contains the text you want to use as a subject line.
Defined in
Click here to see this topic
lotus.notes.Newsletter
Click here to see this topic
Data type
String
Syntax
public String getSubjectItemName()
throws NotesException
public void setSubjectItemName(String name)
throws NotesException
Usage
This property has no effec for a newsletter document created using the
Click here to see this topic
FormatDocument method
Click here to see this topic
This property must be used in conjunction with the
Click here to see this topic
DoSubject property
Click here to see this topic
, which determines whether or not a subject line is included in the newsletter. For example, if the DoSubject property is true and SubjectItemName is "Topic," then the newsletter contains the contents of each document's Topic item next to the document's link. If the DoSubject property is false, the SubjectItemName property has no effect.s
You must set both SubjectItemName and DoSubject before calling formatMsgWithDoclinks.
Click here to see this topic
See examples
Click here to see this topic
See related topics
Click here to see this topic
formatDocument method
Click here to see this topic
Click here to see this topic
formatMsgWithDoclinks method
Click here to see this topic
Click here to see this topic
IsDoScore property
Click here to see this topic
Click here to see this topic
IsDoSubject property
Click here to see this topic
1l8ps
1l8ps
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. The surname part of the name, or null if the property is undefined.
Defined in
Click here to see this topic
lotus.notes.Name
class
Click here to see this topic
Data type
String
Syntax
public String getSurName()
throws NotesException
Click here to see this topic
See examples
Click here to see this topic
See related topics
Click here to see this topic
Generation property
Click here to see this topic
Click here to see this topic
Given property
Click here to see this topic
Click here to see this topic
Initials propertyv
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Switches to a different ID file.
Defined in
Click here to see this topic
lotus.n
otes.Registration class
Click here to see this topic
Syntax
public String switchToID(String idfile, String userpw)
throws NotesException
Parameters
String idfile
The ID file to which you want to switch. Specify the complete path; for example, c:\notes\data\cert.id.a
String userpw
The user's password.
Return Value
String
The username that corresponds to the ID file to which you have switched.
Click here to see this topic
See examples
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. The template name of a database, if the database is a template. If the database is not a template, returns null.
Defined in
Click here to see this topic
lotus.notes.Database
Click here to see this topic
Data type
Object of type java.lang.String
Syntax
public String getTemplateName()
throws NotesException
Click here to see this topic
See examples
See related topics
Click here to see this topic
createFromTemplate method
Click here to see this topic
Click here to see this topic
DesignTemplateName property
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. A plain text representation of an item's value.
Defined in
Click here to see this topic
lotus.notes.Item
Click here to see this topic
Data typea
Object of type java.lang.String
Syntax
public String getText()
throws NotesExceptioni
public String getText(int maxlen)
throws NotesExceptionM
Parameters
int maxlen
Maximum length of returned text.
UsageN
Multiple values in a list are separated by semicolons in the returned string. If an item's value is large, the returned string may be truncated.
For rich text items, this property skips non-text data such as bitmaps and file attachments.
For HTML items, this property returns null.
Click here to see this topic
See examples
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-write. The text associated with a range.E
Defined in
Click here to see this topic
lotus.notes.DateRangee
Click here to see this topic
Data types
Object of type java.lang.String
Syntax
public String getText()
throws NotesExceptiona
public void setText(String text)
throws NotesException
Click here to see this topic
See examples
Click here to see this topic
See related topics
Click here to see this topic
createDateRange method
Click here to see this topic
Click here to see this topic
EndDateTime property
Click here to see this topic
Click here to see this topic
freeTimeSearch methoda
Click here to see this topic
Click here to see this topic
StartDateTime property
Click here to see this topic
Click here to see this topic
Working with Notes time
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. The thousands separator in number format, for example, the comma.
Defined in
Click here to see this topic
lotus.notes.International Class
Click here to see this topic
Data type
Object of type java.lang.Stringr
Syntax
public String getThousandsSep()
throws NotesExceptione
Click here to see this topic
See examples
Click here to see this topic
See related topics
Click here to see this topic
Accessing international settings
Click here to see this topic
Click here to see this topic
CurrencyDigits property
Click here to see this topic
Click here to see this topic
DecimalSep propertye
Click here to see this topic
Click here to see this topic
IsCurrencyZero property
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Finds the difference in seconds between the one date-time and another.
Defined in
Click here to see this topic
lotus.notes.DateTime
Click here to see this topic
Syntax
public int timeDifference(lotus.notes.DateTime dt)
throws NotesException
ParameterS
lotus.notes.DateTime dto
Any date-time value.
Return value
int
The current date-time minus the specified date-time, in seconds.
Click here to see this topic
See examples
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. A string representation of the time part of the time-date.b
Defined in
Click here to see this topic
lotus.notes.DateTime
Click here to see this topic
Data typeN
String
Syntax
public String getTimeOnly()
throws NotesException
Click here to see this topic
See examples
Click here to see this topic
See related topics
Click here to see this topic
convertToZone method
Click here to see this topic
6DP'Q
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. The character used to separate hours, minutes, and seconds, for example, the colon.
Defined in
Click here to see this topic
lotus.notes.International Classv
Click here to see this topic
Data types
Object of type java.lang.String
Syntax
public String getTimeSep()
throws NotesException
Click here to see this topic
See examples
Click here to see this topic
See related topics
Click here to see this topic
Accessing international settings
Click here to see this topic
Click here to see this topic
AMString property
Click here to see this topic
Click here to see this topic
IsTime24Hour property
Click here to see this topic
Click here to see this topic
PMString property
Click here to see this topic
Click here to see this topic
TimeZone property
Click here to see this topic
}%ALh:ts
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. An integer representing the time zone. In many cases, but not all, this integer indicates the number of hours which must be added to the time to get Greenwich Mean Time. May be positive or negative.C
Defined in
Click here to see this topic
lotus.notes.International Class
Click here to see this topic
Data typek
Syntax
public int getTimeZone()
throws NotesException
Click here to see this topic
See examples
Click here to see this topic
See related topics
Click here to see this topic
Accessing international settings
Click here to see this topic
Click here to see this topic
AMString property
Click here to see this topic
Click here to see this topic
IsTime24Hour property
Click here to see this topic
Click here to see this topic
PMString propertyg
Click here to see this topic
Click here to see this topic
TimeSep property
Click here to see this topic
}%ALh:ts
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. An integer representing the time zone of a date-time. In many cases, but not all, this integer indicates the number of hours that must be added to the time to get Greenwich Mean Time. May be positive or negative.(
Defined in
Click here to see this topic
lotus.notes.DateTime
Click here to see this topic
Data type
Integer)
Syntax
public int getTimeZone()
throws NotesException
Usage
When you create a new lotus.notes.DateTime object, this property is set according to the time zone setting of the computer on which the program runs.
When you access a date-time value from an item on a document using the DateTimeValue property in lotus.notes.Item, this property is set according to the time zone stored in the item.
Click here to see this topic
See examples
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. The title of a column, if any.
Defined in
Click here to see this topic
lotus.notes.ViewColumn
Click here to see this topic
Data typea
Object of type java.lang.String
Syntax
public String getTitle()
throws NotesException
Click here to see this topic
See examples
See related topics
Click here to see this topic
Formula property
Click here to see this topic
Click here to see this topic
ItemName property
Click here to see this topic
Click here to see this topic
Position property
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-Write. The title of a database.
Defined in
Click here to see this topic
lotus.notes.Database
Click here to see this topic
Data type
Object of type java.lang.String
Syntax
public String getTitle()
throws NotesException
public void setTitle(String title)
throws NotesException
Usage
A program cannot change the title of the database in which the script is currently running.e
Click here to see this topic
See examples
See related topics
Click here to see this topic
FileName property
Click here to see this topic
Click here to see this topic
FilePath property
Click here to see this topic
Click here to see this topic
Server property
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. The string that means today in a time-date specification, for example, "Today" in English.
Defined in
Click here to see this topic
lotus.notes.International Classr
Click here to see this topic
Data type
Object of type java.lang.Stringi
Syntax
public String getToday()
throws NotesException
Click here to see this topic
See examples
Click here to see this topic
See related topics
Click here to see this topic
Accessing international settings
Click here to see this topic
Click here to see this topic
DateSep property
Click here to see this topic
Click here to see this topic
IsDateDMY property
Click here to see this topic
Click here to see this topic
IsDateMDY property
Click here to see this topic
Click here to see this topic
IsDateYMD property
Click here to see this topic
Click here to see this topic
IsDST property
Click here to see this topic
Click here to see this topic
IsDST property
Click here to see this topic
Click here to see this topic
Tomorrow property
Click here to see this topic
Click here to see this topic
Yesterday property
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. The string that means tomorrow in a time-date specification, for example, "Tomorrow" in English.
Defined in
Click here to see this topic
lotus.notes.International Class
Click here to see this topic
Data type
Object of type java.lang.String
Syntax
public String getTomorrow()
throws NotesException
Click here to see this topic
See examples
Click here to see this topic
See related topics
Click here to see this topic
Accessing international settings
Click here to see this topic
Click here to see this topic
DateSep property
Click here to see this topic
Click here to see this topic
IsDateDMY property
Click here to see this topic
Click here to see this topic
IsDateMDY property
Click here to see this topic
Click here to see this topic
IsDateYMD property
Click here to see this topic
Click here to see this topic
IsDST property
Click here to see this topic
Click here to see this topic
IsDST property
Click here to see this topic
Click here to see this topic
Today property
Click here to see this topic
Click here to see this topic
Yesterday property
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
The following lotus.notes classes override the toString method of java.lang.Object:
ACLEntry
Agent
AgentContext
Database
DateRange
DateTime
DbDirectory
Document
EmbeddedObject
Session
ViewColumn
The toString method converts primitive values such as int and double as expected. The toString method renders objects to an appropriate string, if possible, or invents a string.
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. The data type of an item.
Defined in
Click here to see this topic
lotus.notes.Item
Click here to see this topic
Data typea
inti
Syntax
public int getType()
throws NotesException
Legal values
ATTACHMENT
File attachment
AUTHORS
Authors
DATETIMES
Date-time value or range of date-time values
EMBEDDEDOBJECT
Embedded object
ERRORITEMR
An error occurred while accessing the type
FORMULA
Notes formulaf
HTML
HTML source text
ICON
Icon
NAMESs
Names
NOTELINKS
Link (to a database, view, or document)
NOTEREFS
Reference to the parent document
NUMBERS
Number or number lista
OTHEROBJECT
Other object
RICHTEXT
Rich text
READERS
Readers
SIGNATURE
Signature
TEXT
Text or text list, Names, Authors, or Readers
UNAVAILABLE
The item type isn't available
UNKNOWN
The item type isn't known
USERDATA
User datal
USERID
User ID name
Usagec
You can also test for Names, Readers, and Authors items with:t
Click here to see this topic
IsNames
Click here to see this topic
Click here to see this topic
IsReaderso
Click here to see this topic
Click here to see this topic
IsAuthors
Click here to see this topic
Click here to see this topic
See examples
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. Indicates if a lotus.notes.EmbeddedObject is an embedded object, an object link, or a file attachment.
Defined in
Click here to see this topic
lotus.notes.EmbeddedObject
Click here to see this topic
Data type
inte
Syntax
public int getType()
throws NotesException
Return Values
EMBED_ATTACHMENT
A file attachment
EMBED_OBJECT
An embedded object
EMBED_OBJECTLINK
An object link
Click here to see this topic
See examples
See related topics
Click here to see this topic
ClassName property
Click here to see this topic
Click here to see this topic
Name property
Click here to see this topic
Click here to see this topic
Source property
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-Write. Strikethrough rich text attribute.
Defined in
Click here to see this topic
lotus.notes.
RichTextStyle
Click here to see this topic
Data type
Syntax
public int getUnderline()
throws NotesException
public void setUnderline(int value)
throws NotesException
Legal values
YES for underline
NO for non-underline
STYLE_NO_CHANGE to maintain the previous state
Click here to see this topic
See examples
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-write. Indicates if uniform access is set.
Defined in
Click here to see this topic
lotus.notes.ACL class
Click here to see this topic
Data typeJ
boolean
Syntax
public boolean isUniformAccess()
throws NotesException
public void setUniformAccess(boolean flag)
throws NotesException
Legal values
True
Uniform access is set.
False
Uniform access is not set.
UsageY
In the Notes UI, this property is in the advanced section of database properties: "Enforce a consistent Access Control List across all replicas of this database."
Click here to see this topic
See examples
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-write. The universal ID of a document, which is a 32-character combination of hexadecimal digits (0-9, A-F) that uniquely identifies a document across all replicas of a database. If two documents in replica databases share the same universal ID, the documents are replicas.
The universal ID is also known as the unique ID or UNID.
Defined in
Click here to see this topic
lotus.notes.Document
Click here to see this topic
Data typee
Object of type java.lang.String
Syntax
public String getUniversalID()
throws NotesException
public void setUniversalID(String unid)
throws NotesException
Usage
If you modify the UNID of an existing document, it becomes a new document.
If you set the UNID of a document the same as another document, you get Notes run-time error 4000 when you attempt to save the document.
Click here to see this topic
See examples
See related topics
GetDocumentByUNID method
H_GETDOCUMENTBYUNID_METHOD_JAVA in lotus.notes.Database
NoteID property
H_NOTEID_PROPERTY_JAVA
ParentDocumentUNID property
H_PARENTDOCUMENTUNID_PROPERTY
_JAVA
See related topics
Click here to see this topic
getDocumentByUNID method
Click here to see this topic
Click here to see this topic
NoteID property"
Click here to see this topic
Click here to see this topic
ParentDocumentUNID property
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. The Universal ID of a view, which is a 32-character combination of letters and numbers that uniquely identifies a view across all replicas of a database.
Defined in
Click here to see this topic
lotus.notes.View
Click here to see this topic
Data typeT
Object of type java.lang.String
Syntax
public String getUniversalID()
throws NotesException
Usage
A typical universal ID looks like this: FF864D9ACB6E2210752561BC005867C6
Click here to see this topic
See examples
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. The documents in a database that the current agent considers to be "unprocessed." The type of agent determines which documents are considered unprocessed.
Defined in
Click here to see this topic
lotus.notes.AgentContext
Click here to see this topic
Data typeT
Click here to see this topic
lotus.notes.DocumentCollection
Click here to see this topic
Syntax
public lotus.notes.DocumentCollection getUnprocessedDocuments()
throws NotesException
Usage
This method is valid only for agents.o
What documents are returned?
The following table describes the documents that are returned by getUnprocessedDocuments.
Agent runs on:
u&([P
UnprocessedDocuments returns documents that meet all of these requirements:
All documents in databasec
Meet the search criteria specified in Agent Builder
All new and modified documents since last rune
Not processed by this agent with updateProcessedDocV
Just created or modified
Meet the search criteria specified in Agent Builder
All unread documents in view
Are unread and in the view
Meet the search criteria specified in Agent Builder
All documents in view
Are in the view
Meet the search criteria specified in Agent Builder
Selected documents
Are selected in the view
Meet the search criteria specified in Agent Builderm
Run once
Is the current document
Using UpdateProcessedDoc
For agents that run on new and modified documents, you must use
Click here to see this topic
updateProcessedDoc
Click here to see this topic
in lotus.notes.Session to mark each document as "processed," which ensures that a document gets processed by the agent only once (unless it's modified again). If you do not call this method for each document, the agent processes the same documents the next time it runs.u
The updateProcessedDoc method marks a document as processed only for the particular agent from which it is called. Using updateProcessedDoc in one agent has no effect on the documents that another agent processes.h
Click here to see this topic
See examples
Click here to see this topic
See related topics
Click here to see this topic
AllDocuments property
Click here to see this topic
Click here to see this topic
CurrentDatabase property
Click here to see this topic
Click here to see this topic
unprocessedFTSearch method
Click here to see this topic
Click here to see this topic
unprocessedSearch method
Click here to see this topic
Click here to see this topic
updateProcessedDoc method
Click here to see this topic
f-G11W
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Given selection criteria for a document, returns documents in a database that:
The current agent considers to be unprocessed
And match the query
Defined in
Click here to see this topic
lotus.notes.AgentContext
Click here to see this topic
Syntax
public lotus.notes.DocumentCollection unprocessedFTSearch(String query, int maxdocs)
throws NotesException
public lotus.notes.DocumentCollection unprocessedFTSearch(String query, int maxdocs, int sortopt, int otheropt)
throws NotesException
Parameters
String query
The full text query.
int maxdocs
Integer. The maximum number of documents you want returned from the query. Set this parameter to 0 to receive all matching documents.
int sortopt
Use one of three constants to specify a sorting option:e
lotus.notes.Database.FT_SCORES (default) sorts by relevance score with highest relevance first.
lotus.notes.Database.FT_DATE_DES sorts by document creation date in descending order.
lotus.notes.Database.FT_DATE_ASC sorts by document creation date in ascending order.
int otheropt
Use one or two constants (qualified by the class name) to specify additional search options:
lotus.notes.Database.FT_STEMS uses stem words as the basis of the search.
lotus.notes.Database.FT_THESAURUS uses the thesaurus to search.
You can use both options together by specifying FT_STEMS + FT_THESAURUS.
Return Value
lotus.notes.DocumentCollection
A sorted collection of documents that were unprocessed and match the query.F
Usage
This method is valid only for agents.h
How does it work?F
This method works in two parts:
First, it finds a collection of documents that the agent considers to be "unprocessed." The type of agent determines which documents are considered to be unprocessed. This document collection is identical to that returned by
Click here to see this topic
getUnprocessedDocumentsa
Click here to see this topic
Second, it conducts a full-text search on the unprocessed documents and returns a collection of those documents that match the query.
For example, in an agent that runs on all selected documents in a view, getUnprocessedFTSearch searches only the selected documents and returns those that match the query. In an agent that runs on all new and modified documents since the last run, getUnprocessedFTSearch searches only the documents that were not marked by
Click here to see this topic
updateProcessedDoc
Click here to see this topic
, and returns those that match the query.
What documents are returned?
The following table describes the documents that are returned by unprocessedFTSearch.
Agent runs on:
"%([P
unprocessedFTSearch returns documents that meet all of these requirements:
All documents in database
Meet the search criteria specified in Agent Builder
Meet the full text search critieria specified in this method
All new and modified documents since last runs
Not processed by this agent with updateProcessedDocp
Just created or modified
Meet the search criteria specified in Agent Buildere
Meet the full text search critieria specified in this method
All unread documents in viewe
Are unread and in the view
Meet the search criteria specified in Agent Buildert
Meet the full text search criteria specified in this methodt
All documents in view
Are in the view
Meet the search criteria specified in Agent Buildero
Meet the full text search criteria specified in this methodc
Selected documents
Are selected in the view
Meet the search criteria specified in Agent Buildert
Meet the full text search criteria specified in this method
Run once
Is the current document
Using UpdateProcessedDoc
For agents that run on new and modified documents, you must use
Click here to see this topic
updateProcessedDoc
Click here to see this topic
to mark each document as "processed," which ensures that a document gets processed by the agent only once (unless it's modified again). If you do not call this method for each document, the agent processes the same documents the next time it runs.
The updateProcessedDoc method marks a document as processed only for the particular agent from which it is called. Using updateProcessedDoc in one agent has no effect on the documents that another agent processes.s
Full text indexes
If the database is not full text indexed, this method works, but less efficiently. To test for an index, use
Click here to see this topic
isFTIndexed
Click here to see this topic
. To create an index on a local database, use
Click here to see this topic
updateFTIndex
Click here to see this topic
Click here to see this topic
See examples
Click here to see this topic
See related topics
Click here to see this topic
Accessing Notes agents
Click here to see this topic
Click here to see this topic
FTSearch methoda
Click here to see this topic
Click here to see this topic
FTSearch method
Click here to see this topic
Click here to see this topic
FTSearchScore property
Click here to see this topic
Click here to see this topic
LastFTIndexed property
Click here to see this topic
Click here to see this topic
lotus.notes.DocumentCollection class
Click here to see this topic
Click here to see this topic
UnprocessedDocuments property
Click here to see this topic
Click here to see this topic
unprocessedSearch method
Click here to see this topic
Click here to see this topic
updateFTIndex method
Click here to see this topic
Click here to see this topic
updateProcessedDoc methods
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Given selection criteria for a document, returns documents in a database that:
The current agent considers to be unprocessed_
Meet the selection criteria
Were created or modified since the cutoff date
Defined in
Click here to see this topic
lotus.notes.AgentContext
Click here to see this topic
Syntax
public lotus.notes.DocumentCollection unprocessedSearch(String formula, lotus.notes.DateTime limit, int maxdocs)
throws NotesException
Parameters
String formula
A Notes formula that defines the selection criteria.
lotus.notes.DateTime limit
A cutoff date. This method searches only documents created or modified since the cutoff date.
int maxdocs
The maximum number of documents you want returned. Set this parameter to 0 to receive all matching documents.
Return value
lotus.notes.DocumentCollection
A collection of documents that are unprocessed, match the selection criteria, and were created or modified after the cutoff date. The collection is sorted by relevance with highest relevance first.m
Usaget
This method is valid only for agents.u
How does it work?
This method works in two parts:
First, it finds a collection of documents that the agentn considers to be "unprocessed." The type of agent determines which documents are considered to be unprocessed. This document collection is identical to that returned by
Click here to see this topic
unprocessedFTSearchg
Click here to see this topic
Second, it conducts a search on the unprocessed documents, and returns a collection of those documents that match the selection criteria and were created or modified since the cutoff date.
For example, in an agent that runs on all selected documents in the view, unprocessedSearch searches only the selected documents and returns those that match the selection criteria. In an agent that runs on all new and modified documents since the last run, unprocessedSearch searches only the documents that were not marked by
Click here to see this topic
updateProcessedDoc
Click here to see this topic
, and returns those that match the selection criteria.
What documents are returned?
The following table describes the documents that are returned by unprocessedSearch.
Agent runs on:
l%HWP
unprocessedSearch returns documents that meet all of these requirements:
All documents in database
Meet the search criteria specified in Agent Builder
Meet the formula search critieria specified in this method
Meet the cutoff date specified in this method
All new and modified documents since last run
Not processed by this agent with updateProcessedDoce
Just created or modified
Meet the search criteria specified in Agent Builder
Meet the formula search critieria specified in this method
Meet the cutoff date specified in this method
All unread documents in viewe
Are unread and in the view
Meet the search criteria specified in Agent Builder
Meet the formula search criteria specified in this methodE
Meet the cutoff date specified in this methodt
All documents in view
Are in the view
Meet the search criteria specified in Agent Builderc
Meet the formula search criteria specified in this method
Meet the cutoff date specified in this methodm
Selected documents r
Are selected in the view
Meet the search criteria specified in Agent Buildero
Meet the formula search criteria specified in this methodl
Meet the cutoff date specified in this methodm
Run once
Meet the formula search criteria specified in this method,
Meet the formula search criteria specified in this methods
Meet the cutoff date specified in this methodo
Using UpdateProcessedDoc
For agents that run on new and modified documents, you must use
Click here to see this topic
updateProcessedDoc
Click here to see this topic
to mark each document as "processed," which ensures that a document gets processed by the agent only once (unless it's modified again). If you do not call this method for each document, the agent processes the same documents the next time it runs.
The updateProcessedDoc method marks a document as processed only for the particular agent from which it is called. Using updateProcessedDoc in one agent has no effect on the documents that another agent processes.
Click here to see this topic
See examples
Click here to see this topic
See related topics
Click here to see this topic
lotus.notes.DateTime class
Click here to see this topic
Click here to see this topic
lotus.notes.DocumentCollection class
Click here to see this topic
Click here to see this topic
search methodV
Click here to see this topic
Click here to see this topic
UnprocessedDocuments property
Click here to see this topic
Click here to see this topic
unprocessedFTSearch method
Click here to see this topic
Click here to see this topic
updateProcessedDoc methodu
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-Write. Indicates whether the server entry in the address book is updated when the ID file is created when calling
Click here to see this topic
egisterNewUser
Click here to see this topic
Click here to see this topic
egisterNewServer
Click here to see this topic
, and
Click here to see this topic
egisterNewCertifierk
Click here to see this topic
Defined in
Click here to see this topic
lotus.notes.Registration class
Click here to see this topic
Data type
boolean
Syntax
public boolean getUpdateAddressBook()
throws NotesExceptione
public void setUpdateAddressBook(boolean flag)
throws NotesException
Legal Values
True
The address book is updated.
False
The address book is not updated.
Click here to see this topic
See examples
See related topics
Click here to see this topic
StoreIDInAddressBook property
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Marks all documents in a collection as processed by an agent.n
Defined in
Click here to see this topic
lotus.notes.DocumentCollection
Click here to see this topic
Syntax
public void updateAll()
throws NotesExceptiona
Usages
See the UpdateProcessedDoc method in lotus.notes.Session for a description of the update process.
Click here to see this topic
See examples
See related topics
Click here to see this topic
lotus.notes.Document class
Click here to see this topic
Click here to see this topic
UnprocessedDocuments propertyC
Click here to see this topic
Click here to see this topic
unprocessedFTSearch method
Click here to see this topic
Click here to see this topic
unprocessedSearch method
Click here to see this topic
Click here to see this topic
updateProcessedDoc methodo
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Updates the database's full text index.
Defined in
Click here to see this topic
lotus.notes.Database
Click here to see this topic
Syntax
public void updateFTIndex(boolean create)
throws NotesException
Parameter
boolean create
Specify true if you want to create an index if none exists (valid only for local databases). Otherwise, specify false.
Usager
Notes returns an error if you attempt to create a full text index on a database that is not local.
Click here to see this topic
See examples
See related topics
Click here to see this topic
FTSearch methoda
Click here to see this topic
Click here to see this topic
FTSearch method7
Click here to see this topic
Click here to see this topic
IsFTIndexed property
Click here to see this topic
Click here to see this topic
LastFTIndexed property
Click here to see this topic
Click here to see this topic
Server property
Click here to see this topic
Click here to see this topic
unprocessedFTSearch method
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Marks a document as processed by an agent.
Defined in
Click here to see this topic
lotus.notes.AgentContext
Click here to see this topic
Syntax
public void updateProcessedDoc(lotus.notes.Document doc)
throws NotesException
Parameter
lotus.notes.Document doc
The document to be marked as processed.R
Usage
Use this method in conjunction with
Click here to see this topic
getUnprocessedDocumentsi
Click here to see this topic
Click here to see this topic
unprocessedFTSearch
Click here to see this topic
, and
Click here to see this topic
unprocessedSearch
Click here to see this topic
. This method is intended for agents that run on all new and modified documents since the last run. In other programs, this method has no effect.e
What does it do?
This method ensures that a document gets processed by an agent only once. When an agent runs a program to process all new and modified documents since the last run, the program can use getUnprocessedDocuments, unprocessedFTSearch, or unprocessedSearch to get the newly created and newly modified documents, but must use updateProcessedDoc to mark the documents that it processes.
Without updateProcessedDoc, getUnprocessedDocuments returns all the documents in the database, and unprocessedFTSearch and unprocessedSearch return all the documents in the database that meet their respective criteria, regardless of whether the documents have already been searched in a previous invocation of the agent.
This method marks a document as processed only for the particular agent from which it is called. Using UpdateProcessedDoc in one agent has no effect on the documents that another agent processes.
Click here to see this topic
See examples
Click here to see this topic
See related topics
Click here to see this topic
lotus.notes.Document class
Click here to see this topic
Click here to see this topic
UnprocessedDocuments propertya
Click here to see this topic
Click here to see this topic
unprocessedFTSearch method
Click here to see this topic
Click here to see this topic
unprocessedSearch method
Click here to see this topic
Click here to see this topic
updateAll method
Click here to see this topic
uS*|=
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. The name, in the form of a Name object, of the user or server that owns the local Notes directory.
Defined in
Click here to see this topic
lotus.notes.SessionB
Click here to see this topic
Data typeN
Click here to see this topic
lotus.notes.Name
Click here to see this topic
Syntax
public lotus.notes.Name getUserNameObject()
throws NotesExceptiona
Click here to see this topic
See examples
Click here to see this topic
See related topics
Click here to see this topic
Accessing session properties
Click here to see this topic
Click here to see this topic
CommonUserName propertyn
Click here to see this topic
Click here to see this topic
EffectiveUserName property
Click here to see this topic
Click here to see this topic
lotus.notes.Name class
Click here to see this topic
Click here to see this topic
UserName property
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. The full name of the user or server that owns the local Notes directory.N
Defined in
Click here to see this topic
lotus.notes.Session
Click here to see this topic
Data type
String
Syntax
public String getUserName()
throws NotesException
Usage
If the user name is hierarchical, this property returns the fully distinguished name. To get only the common name, use the CommonUserName property.
Click here to see this topic
See examples
Click here to see this topic
See related topics
Click here to see this topic
Accessing session properties
Click here to see this topic
Click here to see this topic
CommonUserName property
Click here to see this topic
Click here to see this topic
EffectiveUserName property
Click here to see this topic
Click here to see this topic
lotus.notes.Name class
Click here to see this topic
Click here to see this topic
UserNameObject propertyr
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
The
Click here to see this topic
etEnvironmentValue
Click here to see this topic
Click here to see this topic
etEnvironmentString
Click here to see this topic
, and
Click here to see this topic
etEnvironmentVar
Click here to see this topic
methods retrieve and set environment variables, which are stored in the local notes.ini or Notes Preferences file. Use
Click here to see this topic
getEnvironmentValuet
Click here to see this topic
only for numeric environment variables. Use b
Click here to see this topic
getEnvironmentString
Click here to see this topic
for strings and numeric values.
Click here to see this topic
SetEnvironmentVar
Click here to see this topic
prepends a dollar sign ($) to parameter 1, the name of the environment variable, if the third parameter is false or omitted. The dollar sign distinguishes user environment variables (name starts with a dollar sign) and system environment variables (name does not start with a dollar sign).
Click here to see this topic
GetEnvironmentValue
Click here to see this topic
and
Click here to see this topic
getEnvironmentString
Click here to see this topic
prepend a dollar sign if the second parameter is false or omitted, and do not prepend a dollar sign if the second parameter is true.
Environment variables are useful for saving state and data between program invocations where no conflicts are possible. They are also useful for obtaining the environment information set by Notes, such as KitType, Directory, Preferences, Domain, Port, and so on.
Click here to see this topic
See examples
Click here to see this topic
6db<}
6db<}
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-Write. The value that an item holds.
Defined in
Click here to see this topic
lotus.notes.Item
Click here to see this topic
Data typei
double.
Syntax
public double getValueDouble()
throws NotesException
public setValueDouble(double value)
throws NotesException
Click here to see this topic
See examples
See related topics
Click here to see this topic
getItemValue method
Click here to see this topic
Click here to see this topic
replaceItemValue method-
Click here to see this topic
Click here to see this topic
Type property
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-Write. The value that an item holds.
Defined in
Click here to see this topic
lotus.notes.Item
Click here to see this topic
Data typei
int.
Syntax
public int getValueInteger()
throws NotesException
public setValueInteger(int value)
throws NotesException
Click here to see this topic
See examples
See related topics
Click here to see this topic
getItemValue methode
Click here to see this topic
Click here to see this topic
replaceItemValue methodt
Click here to see this topic
Click here to see this topic
Type propertyu
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. The size of an item's value in bytes.
Defined in
Click here to see this topic
lotus.notes.Item
Click here to see this topic
Data type
Syntax
public int getValueLength()
throws NotesExceptionP
Click here to see this topic
See examples
See related topics
Click here to see this topic
abstractText method
Click here to see this topic
Click here to see this topic
FileSize propertyu
Click here to see this topic
Click here to see this topic
Size property
Click here to see this topic
Click here to see this topic
Values property
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-Write. The value that an item holds.
Defined in
Click here to see this topic
lotus.notes.Item
Click here to see this topic
Data typei
String
Syntax
public String getValueString()
throws NotesException
public setValueString(String value)
throws NotesException
Click here to see this topic
See examples
See related topics
Click here to see this topic
getItemValue method
Click here to see this topic
Click here to see this topic
replaceItemValue methodt
Click here to see this topic
Click here to see this topic
Type property
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-Write. The value(s) that an item holds.
Defined in
Click here to see this topic
lotus.notes.Item
Click here to see this topic
Data type
Object of type java.utili.Vector. The data type of each element depends upon the type of the item.
Item typee
Values data type
Rich text
java.lang.String. The text in the field, rendered into plain text
Text or text list (includes Names, Authors, and Readers item types)w
java.lang.String
Number or number list
lotus.notes.DateTime
Date-time or range of date-time values
lotus.notes.DateTime
Attachment
java.lang.Strings. The name of the attachment in element 0.
Syntax
public java.util.Vector getValues()
throws NotesException6
public void setValues(java.util.Vector values)
throws NotesException
Usage
For attachments, the attachment name can be passed to the GetAttachment method in lotus.notes.Document.V
This property returns the same value(s) for an item as the GetItemValue method in lotus.notes.Document.
Click here to see this topic
See examples
See related topics
Click here to see this topic
getItemValue method
Click here to see this topic
Click here to see this topic
replaceItemValue method
Click here to see this topic
Click here to see this topic
Type propertyd
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. The verbs that an object supports, if the object is an OLE/2 embedded object.
Defined in
Click here to see this topic
lotus.notes.EmbeddedObject
Click here to see this topic
Data typen
Object of type java.util.Vector whose elements are of type java.lang.String
Syntax
public java.util.Vector getVerbs()
throws NotesException
Usage
To invoke a verb on an object, use the doVerb method.
See related topics
Click here to see this topic
doVerb method
Click here to see this topic
<]Nohps
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. The name of the certificate that verified a signature, if a document is signed.
Defined in
Click here to see this topic
lotus.notes.Document
Click here to see this topic
Data type
Object of type java.lang.String
Syntax
public String getVerifier()
throws NotesException
Click here to see this topic
See examples
See related topics
Click here to see this topic
IsSigned property
Click here to see this topic
Click here to see this topic
sign method
Click here to see this topic
Click here to see this topic
Signer property
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. The views and folders in a database.i
Defined in
Click here to see this topic
lotus.notes.Database
Click here to see this topic
Data typee
Object of type java.util.Vector whose elements are
Click here to see this topic
lotus.notes.View
Click here to see this topic
objects
Syntax
public java.util.Vector getViews()
throws NotesException
Usage-
Each element of the array is a lotus.notes.View object representing a public view or folder in the database. If the database is local, personal folders are also included.
Click here to see this topic
See examples
See related topics
Click here to see this topic
getView method
Click here to see this topic
Click here to see this topic
lotus.notes.View class
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
All lotus.notes classes implement the java.beans.Visibility interface and are configured to be invisible.
needsGui() always returns false.
avoidingGUI() always returns true.
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
The
Click here to see this topic
lotus.notes.Session classf
Click here to see this topic
Is the root of the Notes back-end object containment hierarchy, providing access to the other Notes objects, and represents the Notes environment of the current program.
The Notes environment is the local Notes directory, which can be a server or a user.
A program has only one Notes session so successive instantiations of Session objects return the same object.
See the following topics:
Click here to see this topic
Accessing session properties
Click here to see this topic
Click here to see this topic
Using environment variables
Click here to see this topic
Click here to see this topic
Accessing Notes agents
Click here to see this topic
Click here to see this topic
Accessing international settings
Click here to see this topic
Click here to see this topic
Working with Notes times
Click here to see this topic
Click here to see this topic
Making a Notes log
Click here to see this topic
Click here to see this topic
Making a Notes newsletter
Click here to see this topic
Click here to see this topic
Representing a name
Click here to see this topic
Click here to see this topic
Evaluating a Notes formula
Click here to see this topic
The Session class also contains the following methods for creating new lotus.notes objects:
Click here to see this topic
createDateRange\
Click here to see this topic
Click here to see this topic
createDateTime
Click here to see this topic
Click here to see this topic
createLogs
Click here to see this topic
Click here to see this topic
createName
Click here to see this topic
Click here to see this topic
createNewsletter
Click here to see this topic
Click here to see this topic
createRegistration
Click here to see this topic
Click here to see this topic
createRichTextStyle
Click here to see this topic
Click here to see this topic
getDatabasem
Click here to see this topic
Click here to see this topic
getDbDirectory
Click here to see this topic
Click here to see this topic
getURLDatabase
Click here to see this topic
]6VGA
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. The width of a column.b
Defined in
Click here to see this topic
lotus.notes.ViewColumn
Click here to see this topic
Data typen
int.
Syntax
public int getWidth()
throws NotesException
Click here to see this topic
See examples
See related topics
Click here to see this topic
Formula property
Click here to see this topic
Click here to see this topic
ItemName property
Click here to see this topic
Click here to see this topic
Position property
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
The
Click here to see this topic
lotus.notes.DateTime class
Click here to see this topic
represents a Notes date-time. Use
Click here to see this topic
createDateTime
Click here to see this topic
in lotus.notes.Session to create a DateTime object. Various methods throughout the lotus.notes package return DateTime objects.
The following methods access the lotus.notes.DateTime properties:l
Click here to see this topic
getLocalTime
Click here to see this topic
returns a String value containing a Notes date-time in local time;
Click here to see this topic
etLocalTime
Click here to see this topic
with a String parameter sets the date-time to the local time represented by the String;
Click here to see this topic
etLocalTimei
Click here to see this topic
with int parameters sets the time component of the date-time; S
Click here to see this topic
etLocalDaten
Click here to see this topic
, which takes int parameters, sets the date component of the date-time.m
Click here to see this topic
getGMTTime
Click here to see this topic
returns a String value containing a Notes date-time in GMT.
Click here to see this topic
getDateOnlyi
Click here to see this topic
returns a String value containing the date component of a Notes date-time in local time.v
Click here to see this topic
getTimet
Only
Click here to see this topic
returns a String value containing the date component of a Notes date-time in local time.
Click here to see this topic
getTimeZone
Click here to see this topic
returns an int value containing the time zone of a Notes date-time.
Click here to see this topic
getZoneTime
Click here to see this topic
returns a String value containing a Notes date-time adjusted for the time zone and daylight savings time, which can be changed with
Click here to see this topic
ConvertToZone
Click here to see this topic
Click here to see this topic
isDST
Click here to see this topic
returns true if a date-time is in daylight savings time.
You can change a date-time with the following methods:
Click here to see this topic
adjustSecond
Click here to see this topic
Click here to see this topic
adjustMinute
Click here to see this topic
Click here to see this topic
adjustHour
Click here to see this topic
Click here to see this topic
adjustDayu
Click here to see this topic
Click here to see this topic
adjustMonth;
Click here to see this topic
, and
Click here to see this topic
adjustYear
Click here to see this topic
. You can initialize a date-time or date-time component with the following methods:
Click here to see this topic
setNow
Click here to see this topic
Click here to see this topic
setAnyDate
Click here to see this topic
, and
Click here to see this topic
setAnyTime
Click here to see this topic
. You can get the difference in seconds between two times with R
Click here to see this topic
timeDifference
Click here to see this topic
The
Click here to see this topic
lotus.notes.
DateRange classt
Click here to see this topic
represents a range of dates. The following methods access the lotus.notes.DateTime properties:t
Click here to see this topic
getEndDateTime
Click here to see this topic
returns a lotus.notes.DateTime object representing the end date of the range;
Click here to see this topic
etEndDateTimet
Click here to see this topic
sets the end date of the range to the specification of a DateTime object.
Click here to see this topic
getStart
DateTime
Click here to see this topic
returns a lotus.notes.DateTime object representing the start date of the range; s
Click here to see this topic
etStartp
DateTime
Click here to see this topic
sets the start date of the range to the specification of a DateTime object.
Click here to see this topic
getTexte
Click here to see this topic
returns a String value containing the range (two date-times in String format separated by a hyphen);
Click here to see this topic
etText
Click here to see this topic
sets the range to the specification of a String value.
When you set a DateRange object, either write to StartDate and EndDate, or Text, but not both. Values written to StartDate or EndDate are immediately transcribed to Text, and vice-versa. Any changes made to the DateTime object that is the basis for StartDateTime or EndDateTime also affect the DateRange object.
Click here to see this topic
See examples
Click here to see this topic
R<;_-DZ#`s
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. The string that means yesterday in a time-date specification, for example, "Yesterday" in English.
Defined in
Click here to see this topic
lotus.notes.International Class
Click here to see this topic
Data type
Object of type java.lang.String
Syntax
public String getYesterday()
throws NotesException
Click here to see this topic
See examples
Click here to see this topic
See related topics
Click here to see this topic
Accessing international settings
Click here to see this topic
Click here to see this topic
DateSep property
Click here to see this topic
Click here to see this topic
IsDateDMY property
Click here to see this topic
Click here to see this topic
IsDateMDY property
Click here to see this topic
Click here to see this topic
IsDateYMD property
Click here to see this topic
Click here to see this topic
IsDST property
Click here to see this topic
Click here to see this topic
IsDST property
Click here to see this topic
Click here to see this topic
Today property
Click here to see this topic
Click here to see this topic
Tomorrow propertyp
Click here to see this topic
&Arial
Baskerville
&CommonBullets
5Courier New
1Fixedsys
&Impact
"MS Sans Serif
Symbol
"Small Fonts
"System
1Terminal
Times New Roman
Wingdings
"Univers
Rockwell Light
FPalace Script
Read-only. A string representation of the time adjusted for the TimeZone and IsDST properties.
Defined in
Click here to see this topic
lotus.notes.DateTime
Click here to see this topic
Data type
String
Syntax
public String getZoneTime()
throws NotesException
Usage
Initially ZoneTime is the same as LocalTime. If you use the ConvertToZone method, changes to TimeZone and IsDST are reflected in ZoneTime, but LocalTime stays the same.
Click here to see this topic
See examples
Click here to see this topic
See related topics
Click here to see this topic
convertToZone method
Click here to see this topic
02/10/97 04:54:10 PM Robert Perron/CAM/Lotus updated -Default-
02/10/97 04:53:52 PM Robert Perron/CAM/Lotus deleted Susanna Doyle
02/10/97 04:53:52 PM Robert Perron/CAM/Lotus deleted RISKY
02/10/97 04:53:49 PM Robert Perron/CAM/Lotus deleted Joe Levine
02/10/97 04:53:48 PM Robert Perron/CAM/Lotus deleted FASTLANE
02/10/97 04:53:47 PM Robert Perron/CAM/Lotus deleted Doc
02/10/97 04:53:47 PM Robert Perron/CAM/Lotus deleted David Malone
02/10/97 04:53:44 PM Robert Perron/CAM/Lotus deleted cpd-qa-server